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

Interface ComputeNodeGroup.Builder

    • Method Detail

      • name

        ComputeNodeGroup.Builder name​(String name)

        The name that identifies the compute node group.

        Parameters:
        name - The name that identifies the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • id

        ComputeNodeGroup.Builder id​(String id)

        The generated unique ID of the compute node group.

        Parameters:
        id - The generated unique ID of the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        ComputeNodeGroup.Builder arn​(String arn)

        The unique Amazon Resource Name (ARN) of the compute node group.

        Parameters:
        arn - The unique Amazon Resource Name (ARN) of the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterId

        ComputeNodeGroup.Builder clusterId​(String clusterId)

        The ID of the cluster of the compute node group.

        Parameters:
        clusterId - The ID of the cluster of the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        ComputeNodeGroup.Builder createdAt​(Instant createdAt)

        The date and time the resource was created.

        Parameters:
        createdAt - The date and time the resource was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modifiedAt

        ComputeNodeGroup.Builder modifiedAt​(Instant modifiedAt)

        The date and time the resource was modified.

        Parameters:
        modifiedAt - The date and time the resource was modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ComputeNodeGroup.Builder status​(String status)

        The provisioning status of the compute node group.

        The provisioning status doesn't indicate the overall health of the compute node group.

        Parameters:
        status - The provisioning status of the compute node group.

        The provisioning status doesn't indicate the overall health of the compute node group.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeNodeGroupStatus, ComputeNodeGroupStatus

      • status

        ComputeNodeGroup.Builder status​(ComputeNodeGroupStatus status)

        The provisioning status of the compute node group.

        The provisioning status doesn't indicate the overall health of the compute node group.

        Parameters:
        status - The provisioning status of the compute node group.

        The provisioning status doesn't indicate the overall health of the compute node group.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeNodeGroupStatus, ComputeNodeGroupStatus

      • amiId

        ComputeNodeGroup.Builder amiId​(String amiId)

        The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

        Parameters:
        amiId - The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        ComputeNodeGroup.Builder subnetIds​(Collection<String> subnetIds)

        The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

        Parameters:
        subnetIds - The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        ComputeNodeGroup.Builder subnetIds​(String... subnetIds)

        The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

        Parameters:
        subnetIds - The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • purchaseOption

        ComputeNodeGroup.Builder purchaseOption​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PurchaseOption, PurchaseOption

      • purchaseOption

        ComputeNodeGroup.Builder purchaseOption​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PurchaseOption, PurchaseOption

      • customLaunchTemplate

        ComputeNodeGroup.Builder customLaunchTemplate​(CustomLaunchTemplate customLaunchTemplate)
        Sets the value of the CustomLaunchTemplate property for this object.
        Parameters:
        customLaunchTemplate - The new value for the CustomLaunchTemplate property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamInstanceProfileArn

        ComputeNodeGroup.Builder iamInstanceProfileArn​(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 the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

        Examples

        • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

        • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

        Parameters:
        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 the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

        Examples

        • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

        • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scalingConfiguration

        ComputeNodeGroup.Builder scalingConfiguration​(ScalingConfiguration scalingConfiguration)
        Sets the value of the ScalingConfiguration property for this object.
        Parameters:
        scalingConfiguration - The new value for the ScalingConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceConfigs

        ComputeNodeGroup.Builder instanceConfigs​(Collection<InstanceConfig> instanceConfigs)

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

        Parameters:
        instanceConfigs - A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceConfigs

        ComputeNodeGroup.Builder instanceConfigs​(InstanceConfig... instanceConfigs)

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

        Parameters:
        instanceConfigs - A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • spotOptions

        ComputeNodeGroup.Builder spotOptions​(SpotOptions spotOptions)
        Sets the value of the SpotOptions property for this object.
        Parameters:
        spotOptions - The new value for the SpotOptions property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slurmConfiguration

        ComputeNodeGroup.Builder slurmConfiguration​(ComputeNodeGroupSlurmConfiguration slurmConfiguration)
        Sets the value of the SlurmConfiguration property for this object.
        Parameters:
        slurmConfiguration - The new value for the SlurmConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • errorInfo

        ComputeNodeGroup.Builder errorInfo​(Collection<ErrorInfo> errorInfo)

        The list of errors that occurred during compute node group provisioning.

        Parameters:
        errorInfo - The list of errors that occurred during compute node group provisioning.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • errorInfo

        ComputeNodeGroup.Builder errorInfo​(ErrorInfo... errorInfo)

        The list of errors that occurred during compute node group provisioning.

        Parameters:
        errorInfo - The list of errors that occurred during compute node group provisioning.
        Returns:
        Returns a reference to this object so that method calls can be chained together.