AWS neptune: Neptune ML cluster setup: fix CLI syntax, engine/role names
Summary
Corrects AWS CLI examples for Neptune ML setup: adds missing line-continuation backslashes, updates the parameter group family guidance, renames the IAM role references from SageMakerExcecutionIAMRole/NeptuneMLRole to NeptuneSageMakerIAMRole, and changes the engine from graphdb to neptune with a supported engine version. Also notes that engine version and parameter group family must match.
Security assessment
The change touches IAM role ARNs and VPC endpoint creation commands, but it is a documentation correctness fix (role naming, engine name, shell line continuations) rather than a response to a specific vulnerability or a new security control. No credential, encryption, or exposure guidance is added.
Evidence
+ --role-arn arn:aws:iam::(the ARN number of the role's ARN):role/NeptuneSageMakerIAMRole \
Diff
diff --git a/neptune/latest/userguide/machine-learning-cluster-setup.md b/neptune/latest/userguide/machine-learning-cluster-setup.md index 26bfe6a..291bad4 100644 --- a//neptune/latest/userguide/machine-learning-cluster-setup.md +++ b//neptune/latest/userguide/machine-learning-cluster-setup.md @@ -23 +23 @@ The following AWS CLI commands create a new DB cluster parameter group and set i - --db-parameter-group-family neptune1 + --db-parameter-group-family (the parameter group family that matches your engine version, such as neptune1.3) \ @@ -27 +27 @@ The following AWS CLI commands create a new DB cluster parameter group and set i - 2. Create a `neptune_ml_iam_role` DB cluster parameter set to the ARN of the `SageMakerExcecutionIAMRole` for your DB cluster to use while calling SageMaker AI for creating jobs and getting prediction from hosted ML models: + 2. Create a `neptune_ml_iam_role` DB cluster parameter set to the ARN of the `NeptuneSageMakerIAMRole` for your DB cluster to use while calling SageMaker AI for creating jobs and getting prediction from hosted ML models: @@ -32 +32 @@ The following AWS CLI commands create a new DB cluster parameter group and set i - ParameterValue=ARN of the SageMakerExcecutionIAMRole, \ + ParameterValue=ARN of the NeptuneSageMakerIAMRole, \ @@ -39 +39 @@ Setting this parameter allows Neptune to access SageMaker AI without you having -For information about how to create the `SageMakerExcecutionIAMRole`, see [Create a custom NeptuneSageMakerIAMRole role](./machine-learning-manual-setup.html#ml-manual-setup-sm-role). +For information about how to create the `NeptuneSageMakerIAMRole`, see [Create a custom NeptuneSageMakerIAMRole role](./machine-learning-manual-setup.html#ml-manual-setup-sm-role). @@ -57 +57 @@ Now you can attach the new DB cluster parameter group that you just created to a - --apply-immediately + --apply-immediately \ @@ -64 +64 @@ To make all the parameters effective, you can then reboot the DB cluster: - aws neptune reboot-db-instance + aws neptune reboot-db-instance \ @@ -72,5 +72,5 @@ Or, if you're creating a new DB cluster to use with Neptune ML, you can use the - cluster-name=(the name of the new DB cluster) - aws neptune create-db-cluster - --db-cluster-identifier ${cluster-name} - --engine graphdb \ - --engine-version 1.0.4.1 \ + cluster_name=(the name of the new DB cluster) + aws neptune create-db-cluster \ + --db-cluster-identifier ${cluster_name} \ + --engine neptune \ + --engine-version (a currently supported Neptune engine version) \ @@ -81,5 +81,5 @@ Or, if you're creating a new DB cluster to use with Neptune ML, you can use the - aws neptune create-db-instance - --db-cluster-identifier ${cluster-name} - --db-instance-identifier ${cluster-name}-i \ - --db-instance-class (the instance class to use, such as db.r5.xlarge) - --engine graphdb \ + aws neptune create-db-instance \ + --db-cluster-identifier ${cluster_name} \ + --db-instance-identifier ${cluster_name}-i \ + --db-instance-class (the instance class to use, such as db.r5.xlarge) \ + --engine neptune \ @@ -87,0 +88,2 @@ Or, if you're creating a new DB cluster to use with Neptune ML, you can use the +Specify an engine version and a parameter group family that match, because a DB cluster can only use a parameter group family that supports its engine version. + @@ -93,3 +95,3 @@ Finally, follow the instructions in [Create a custom NeptuneSageMakerIAMRole rol - aws neptune add-role-to-db-cluster - --db-cluster-identifier ${cluster-name} - --role-arn arn:aws:iam::(the ARN number of the role's ARN):role/NeptuneMLRole \ + aws neptune add-role-to-db-cluster \ + --db-cluster-identifier ${cluster_name} \ + --role-arn arn:aws:iam::(the ARN number of the role's ARN):role/NeptuneSageMakerIAMRole \ @@ -114,6 +116,6 @@ This one creates the `sagemaker.runtime` endpoint: - aws ec2 create-vpc-endpoint - --vpc-id (the ID of your Neptune DB cluster's VPC) - --vpc-endpoint-type Interface - --service-name com.amazonaws.(AWS region, like us-east-1).sagemaker.runtime - --subnet-ids (the subnet ID or IDs that you want to use) - --security-group-ids (the security group for the endpoint network interface, or omit to use the default) + aws ec2 create-vpc-endpoint \ + --vpc-id (the ID of your Neptune DB cluster's VPC) \ + --vpc-endpoint-type Interface \ + --service-name com.amazonaws.(AWS region, like us-east-1).sagemaker.runtime \ + --subnet-ids (the subnet ID or IDs that you want to use) \ + --security-group-ids (the security group for the endpoint network interface, or omit to use the default) \ @@ -125,6 +127,6 @@ And this one creates the `sagemaker.api` endpoint: - aws ec2 create-vpc-endpoint - --vpc-id (the ID of your Neptune DB cluster's VPC) - --vpc-endpoint-type Interface - --service-name com.amazonaws.(AWS region, like us-east-1).sagemaker.api - --subnet-ids (the subnet ID or IDs that you want to use) - --security-group-ids (the security group for the endpoint network interface, or omit to use the default) + aws ec2 create-vpc-endpoint \ + --vpc-id (the ID of your Neptune DB cluster's VPC) \ + --vpc-endpoint-type Interface \ + --service-name com.amazonaws.(AWS region, like us-east-1).sagemaker.api \ + --subnet-ids (the subnet ID or IDs that you want to use) \ + --security-group-ids (the security group for the endpoint network interface, or omit to use the default) \