Skip to content

Commit

Permalink
docs(client-pcs): AWS PCS API documentation - Edited the description …
Browse files Browse the repository at this point in the history 
…of the iamInstanceProfileArn parameter of the CreateComputeNodeGroup and UpdateComputeNodeGroup actions; edited the description of the SlurmCustomSetting data type to list the supported parameters for clusters and compute node groups.
  • Loading branch information
awstools committed Sep 26, 2024
1 parent 0e77940 commit 25f3950
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 24 deletions.
129 changes: 109 additions & 20 deletions clients/client-pcs/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,56 @@ export interface ScalingConfigurationRequest {
*/
export interface SlurmCustomSetting {
/**
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters: <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1">
* <code>Prolog</code>
* </a>, <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1">
* <code>Epilog</code>
* </a>, and <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters">
* <code>SelectTypeParameters</code>
* </a>.</p>
* <p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p>
* <ul>
* <li>
* <p>For <b>clusters</b>
* </p>
* <ul>
* <li>
* <p>
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1">
* <code>Prolog</code>
* </a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1">
* <code>Epilog</code>
* </a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters">
* <code>SelectTypeParameters</code>
* </a>
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>For <b>compute node groups</b>
* </p>
* <ul>
* <li>
* <p>
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
* <code>Weight</code>
* </a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://slurm.schedmd.com/slurm.conf.html#OPT_Weight">
* <code>RealMemory</code>
* </a>
* </p>
* </li>
* </ul>
* </li>
* </ul>
* @public
*/
parameterName: string | undefined;
Expand Down Expand Up @@ -283,12 +326,26 @@ export interface CreateComputeNodeGroupRequest {
customLaunchTemplate: CustomLaunchTemplate | undefined;

/**
* <p>The Amazon Resource Name (ARN) of the
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached in order to
* provision instances correctly. The resource identifier of the ARN must start with
* <code>AWSPCS</code>. For example, <code>arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile</code>.
* <p>The Amazon Resource Name (ARN) of the IAM instance
* profile used to pass an IAM role when launching EC2 instances. The role contained
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
* permission. The resource identifier of the ARN must start with
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
* <p class="title">
* <b>Examples</b>
* </p>
* <ul>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
* </p>
* </li>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
* </p>
* </li>
* </ul>
* @public
*/
iamInstanceProfileArn: string | undefined;
Expand Down Expand Up @@ -488,10 +545,26 @@ export interface ComputeNodeGroup {
customLaunchTemplate: CustomLaunchTemplate | undefined;

/**
* <p>The Amazon Resource Name (ARN) of the
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances
* correctly.</p>
* <p>The Amazon Resource Name (ARN) of the IAM instance
* profile used to pass an IAM role when launching EC2 instances. The role contained
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
* permission. The resource identifier of the ARN must start with
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
* <p class="title">
* <b>Examples</b>
* </p>
* <ul>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
* </p>
* </li>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
* </p>
* </li>
* </ul>
* @public
*/
iamInstanceProfileArn: string | undefined;
Expand Down Expand Up @@ -1037,10 +1110,26 @@ export interface UpdateComputeNodeGroupRequest {
scalingConfiguration?: ScalingConfigurationRequest;

/**
* <p>The Amazon Resource Name (ARN) of the
* IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
* <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances
* correctly.</p>
* <p>The Amazon Resource Name (ARN) of the IAM instance
* profile used to pass an IAM role when launching EC2 instances. The role contained
* in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>
* permission. The resource identifier of the ARN must start with
* <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>
* <p class="title">
* <b>Examples</b>
* </p>
* <ul>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>
* </p>
* </li>
* <li>
* <p>
* <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>
* </p>
* </li>
* </ul>
* @public
*/
iamInstanceProfileArn?: string;
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/pcs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1154,7 +1154,7 @@
"iamInstanceProfileArn": {
"target": "com.amazonaws.pcs#InstanceProfileArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances\n correctly.</p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -1628,7 +1628,7 @@
"iamInstanceProfileArn": {
"target": "com.amazonaws.pcs#InstanceProfileArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached in order to\n provision instances correctly. The resource identifier of the ARN must start with \n <code>AWSPCS</code>. For example, <code>arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile</code>.\n </p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -3321,7 +3321,7 @@
"parameterName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Amazon Web Services PCS supports configuration of the following Slurm parameters: <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1\">\n <code>Prolog</code>\n </a>, <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1\">\n <code>Epilog</code>\n </a>, and <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters\">\n <code>SelectTypeParameters</code>\n </a>.</p>",
"smithy.api#documentation": "<p>Amazon Web Services PCS supports configuration of the following Slurm parameters:</p>\n <ul>\n <li>\n <p>For <b>clusters</b>\n </p>\n <ul>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Prolog_1\">\n <code>Prolog</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Epilog_1\">\n <code>Epilog</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_SelectTypeParameters\">\n <code>SelectTypeParameters</code>\n </a>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>For <b>compute node groups</b>\n </p>\n <ul>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Weight\">\n <code>Weight</code>\n </a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://slurm.schedmd.com/slurm.conf.html#OPT_Weight\">\n <code>RealMemory</code>\n </a>\n </p>\n </li>\n </ul>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -3672,7 +3672,7 @@
"iamInstanceProfileArn": {
"target": "com.amazonaws.pcs#InstanceProfileArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n <code>pcs:RegisterComputeNodeGroupInstance</code> permissions attached to provision instances\n correctly.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the <code>pcs:RegisterComputeNodeGroupInstance</code>\n permission. The resource identifier of the ARN must start with \n <code>AWSPCS</code> or it must have <code>/aws-pcs/</code> in its path.</p>\n <p class=\"title\">\n <b>Examples</b>\n </p>\n <ul>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2</code>\n </p>\n </li>\n </ul>"
}
},
"slurmConfiguration": {
Expand Down

0 comments on commit 25f3950

Please sign in to comment.