Package software.amazon.awssdk.services.pcs.model

Class CreateComputeNodeGroupRequest

    • Method Detail

      • clusterIdentifier

        public final String clusterIdentifier()

        The name or ID of the cluster to create a compute node group in.

        Returns:
        The name or ID of the cluster to create a compute node group in.

      • computeNodeGroupName

        public final String computeNodeGroupName()

        A name to identify the cluster. Example: MyCluster

        Returns:
        A name to identify the cluster. Example: MyCluster

      • amiId

        public final String amiId()

        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

        Returns:
        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

      • hasSubnetIds

        public final boolean hasSubnetIds()
        For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • subnetIds

        public final List<String> subnetIds()

        The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

        Returns:
        The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.

      • purchaseOption

        public final PurchaseOption purchaseOption()

        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

        If the service returns an enum value that is not available in the current SDK version, purchaseOption will return PurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from purchaseOptionAsString().

        Returns:
        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
        See Also:
        PurchaseOption

      • purchaseOptionAsString

        public final String purchaseOptionAsString()

        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

        If the service returns an enum value that is not available in the current SDK version, purchaseOption will return PurchaseOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from purchaseOptionAsString().

        Returns:
        Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
        See Also:
        PurchaseOption

      • customLaunchTemplate

        public final CustomLaunchTemplate customLaunchTemplate()
        Returns the value of the CustomLaunchTemplate property for this object.
        Returns:
        The value of the CustomLaunchTemplate property for this object.

      • iamInstanceProfileArn

        public final String iamInstanceProfileArn()

        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 pcs:RegisterComputeNodeGroupInstance permissions attached in order to provision instances correctly. The resource identifier of the ARN must start with AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.

        Returns:
        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 pcs:RegisterComputeNodeGroupInstance permissions attached in order to provision instances correctly. The resource identifier of the ARN must start with AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.

      • scalingConfiguration

        public final ScalingConfigurationRequest scalingConfiguration()

        Specifies the boundaries of the compute node group auto scaling.

        Returns:
        Specifies the boundaries of the compute node group auto scaling.

      • hasInstanceConfigs

        public final boolean hasInstanceConfigs()
        For responses, this returns true if the service returned a value for the InstanceConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • instanceConfigs

        public final List<InstanceConfig> instanceConfigs()

        A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceConfigs() method.

        Returns:
        A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

      • spotOptions

        public final SpotOptions spotOptions()
        Returns the value of the SpotOptions property for this object.
        Returns:
        The value of the SpotOptions property for this object.

      • slurmConfiguration

        public final ComputeNodeGroupSlurmConfigurationRequest slurmConfiguration()

        Additional options related to the Slurm scheduler.

        Returns:
        Additional options related to the Slurm scheduler.

      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object