Interface CapacityProvider.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CapacityProvider.Builder,CapacityProvider>, SdkBuilder<CapacityProvider.Builder,CapacityProvider>, SdkPojo
Enclosing class:
CapacityProvider
@Mutable @NotThreadSafe public static interface CapacityProvider.Builder extends SdkPojo, CopyableBuilder<CapacityProvider.Builder,CapacityProvider>

  • Method Details

    • capacityProviderArn

      CapacityProvider.Builder capacityProviderArn(String capacityProviderArn)

      The Amazon Resource Name (ARN) that identifies the capacity provider.

      Parameters:
      capacityProviderArn - The Amazon Resource Name (ARN) that identifies the capacity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CapacityProvider.Builder name(String name)

      The name of the capacity provider.

      Parameters:
      name - The name of the capacity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cluster

      CapacityProvider.Builder cluster(String cluster)

      The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.

      Parameters:
      cluster - The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      CapacityProvider.Builder status(String status)

      The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

      Parameters:
      status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CapacityProvider.Builder status(CapacityProviderStatus status)

      The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

      Parameters:
      status - The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoScalingGroupProvider

      CapacityProvider.Builder autoScalingGroupProvider(AutoScalingGroupProvider autoScalingGroupProvider)

      The Auto Scaling group settings for the capacity provider.

      Parameters:
      autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoScalingGroupProvider

      default CapacityProvider.Builder autoScalingGroupProvider(Consumer<AutoScalingGroupProvider.Builder> autoScalingGroupProvider)

      The Auto Scaling group settings for the capacity provider.

      This is a convenience method that creates an instance of the AutoScalingGroupProvider.Builder avoiding the need to create one manually via AutoScalingGroupProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoScalingGroupProvider(AutoScalingGroupProvider).

      Parameters:
      autoScalingGroupProvider - a consumer that will call methods on AutoScalingGroupProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedInstancesProvider

      CapacityProvider.Builder managedInstancesProvider(ManagedInstancesProvider managedInstancesProvider)

      The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.

      Parameters:
      managedInstancesProvider - The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedInstancesProvider

      default CapacityProvider.Builder managedInstancesProvider(Consumer<ManagedInstancesProvider.Builder> managedInstancesProvider)

      The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.

      This is a convenience method that creates an instance of the ManagedInstancesProvider.Builder avoiding the need to create one manually via ManagedInstancesProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedInstancesProvider(ManagedInstancesProvider).

      Parameters:
      managedInstancesProvider - a consumer that will call methods on ManagedInstancesProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updateStatus

      CapacityProvider.Builder updateStatus(String updateStatus)

      The update status of the capacity provider. The following are the possible states that is returned.

      DELETE_IN_PROGRESS

      The capacity provider is in the process of being deleted.

      DELETE_COMPLETE

      The capacity provider was successfully deleted and has an INACTIVE status.

      DELETE_FAILED

      The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

      Parameters:
      updateStatus - The update status of the capacity provider. The following are the possible states that is returned.

      DELETE_IN_PROGRESS

      The capacity provider is in the process of being deleted.

      DELETE_COMPLETE

      The capacity provider was successfully deleted and has an INACTIVE status.

      DELETE_FAILED

      The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

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

    • updateStatus

      CapacityProvider.Builder updateStatus(CapacityProviderUpdateStatus updateStatus)

      The update status of the capacity provider. The following are the possible states that is returned.

      DELETE_IN_PROGRESS

      The capacity provider is in the process of being deleted.

      DELETE_COMPLETE

      The capacity provider was successfully deleted and has an INACTIVE status.

      DELETE_FAILED

      The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

      Parameters:
      updateStatus - The update status of the capacity provider. The following are the possible states that is returned.

      DELETE_IN_PROGRESS

      The capacity provider is in the process of being deleted.

      DELETE_COMPLETE

      The capacity provider was successfully deleted and has an INACTIVE status.

      DELETE_FAILED

      The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

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

    • updateStatusReason

      CapacityProvider.Builder updateStatusReason(String updateStatusReason)

      The update status reason. This provides further details about the update status for the capacity provider.

      Parameters:
      updateStatusReason - The update status reason. This provides further details about the update status for the capacity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CapacityProvider.Builder tags(Collection<Tag> tags)

      The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      Parameters:
      tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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

    • tags

      CapacityProvider.Builder tags(Tag... tags)

      The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      Parameters:
      tags - The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

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

    • tags

      CapacityProvider.Builder tags(Consumer<Tag.Builder>... tags)

      The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8

      • Maximum value length - 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CapacityProvider.Builder type(String type)

      The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES , indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.

      Parameters:
      type - The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CapacityProvider.Builder type(CapacityProviderType type)

      The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES , indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.

      Parameters:
      type - The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: