Package software.amazon.awssdk.services.ecs.model

Interface PutClusterCapacityProvidersRequest.Builder

    • Method Detail

      • cluster

        PutClusterCapacityProvidersRequest.Builder cluster​(String cluster)

        The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.

        Parameters:
        cluster - The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capacityProviders

        PutClusterCapacityProvidersRequest.Builder capacityProviders​(Collection<String> capacityProviders)

        The name of one or more capacity providers to associate with the cluster.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        Parameters:
        capacityProviders - The name of one or more capacity providers to associate with the cluster.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

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

      • capacityProviders

        PutClusterCapacityProvidersRequest.Builder capacityProviders​(String... capacityProviders)

        The name of one or more capacity providers to associate with the cluster.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        Parameters:
        capacityProviders - The name of one or more capacity providers to associate with the cluster.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

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

      • defaultCapacityProviderStrategy

        PutClusterCapacityProvidersRequest.Builder defaultCapacityProviderStrategy​(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)

        The capacity provider strategy to use by default for the cluster.

        When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        Parameters:
        defaultCapacityProviderStrategy - The capacity provider strategy to use by default for the cluster.

        When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

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

      • defaultCapacityProviderStrategy

        PutClusterCapacityProvidersRequest.Builder defaultCapacityProviderStrategy​(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)

        The capacity provider strategy to use by default for the cluster.

        When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        Parameters:
        defaultCapacityProviderStrategy - The capacity provider strategy to use by default for the cluster.

        When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

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

      • defaultCapacityProviderStrategy

        PutClusterCapacityProvidersRequest.Builder defaultCapacityProviderStrategy​(Consumer<CapacityProviderStrategyItem.Builder>... defaultCapacityProviderStrategy)

        The capacity provider strategy to use by default for the cluster.

        When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #defaultCapacityProviderStrategy(List).

        Parameters:
        defaultCapacityProviderStrategy - a consumer that will call methods on CapacityProviderStrategyItem.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #defaultCapacityProviderStrategy(java.util.Collection)