Package software.amazon.awscdk.services.ecs

Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ecs.CfnCluster
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:47.037Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable
A CloudFormation AWS::ECS::Cluster.

The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .capacityProviders(List.of("capacityProviders"))
         .clusterName("clusterName")
         .clusterSettings(List.of(ClusterSettingsProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .configuration(ClusterConfigurationProperty.builder()
                 .executeCommandConfiguration(ExecuteCommandConfigurationProperty.builder()
                         .kmsKeyId("kmsKeyId")
                         .logConfiguration(ExecuteCommandLogConfigurationProperty.builder()
                                 .cloudWatchEncryptionEnabled(false)
                                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                                 .s3BucketName("s3BucketName")
                                 .s3EncryptionEnabled(false)
                                 .s3KeyPrefix("s3KeyPrefix")
                                 .build())
                         .logging("logging")
                         .build())
                 .build())
         .defaultCapacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .base(123)
                 .capacityProvider("capacityProvider")
                 .weight(123)
                 .build()))
         .serviceConnectDefaults(ServiceConnectDefaultsProperty.builder()
                 .namespace("namespace")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull Construct scope, @NotNull String id, @Nullable CfnClusterProps props)
      Create a new AWS::ECS::Cluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::ECS::Cluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The metadata that you apply to the cluster to help you categorize and organize them.

      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 AWS 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.

    • getCapacityProviders

      @Stability(Stable) @Nullable public List<String> getCapacityProviders()
      The short name of one or more capacity providers to associate with the cluster.

      A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

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

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

      The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

    • setCapacityProviders

      @Stability(Stable) public void setCapacityProviders(@Nullable List<String> value)
      The short name of one or more capacity providers to associate with the cluster.

      A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

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

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

      The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

    • getClusterName

      @Stability(Stable) @Nullable public String getClusterName()
      A user-generated string that you use to identify your cluster.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

    • setClusterName

      @Stability(Stable) public void setClusterName(@Nullable String value)
      A user-generated string that you use to identify your cluster.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

    • getClusterSettings

      @Stability(Stable) @Nullable public Object getClusterSettings()
      The settings to use when creating a cluster.

      This parameter is used to turn on CloudWatch Container Insights for a cluster.

    • setClusterSettings

      @Stability(Stable) public void setClusterSettings(@Nullable IResolvable value)
      The settings to use when creating a cluster.

      This parameter is used to turn on CloudWatch Container Insights for a cluster.

    • setClusterSettings

      @Stability(Stable) public void setClusterSettings(@Nullable List<Object> value)
      The settings to use when creating a cluster.

      This parameter is used to turn on CloudWatch Container Insights for a cluster.

    • getConfiguration

      @Stability(Stable) @Nullable public Object getConfiguration()
      The execute command configuration for the cluster.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable IResolvable value)
      The execute command configuration for the cluster.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable CfnCluster.ClusterConfigurationProperty value)
      The execute command configuration for the cluster.

    • getDefaultCapacityProviderStrategy

      @Stability(Stable) @Nullable public Object getDefaultCapacityProviderStrategy()
      The default capacity provider strategy for the cluster.

      When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

    • setDefaultCapacityProviderStrategy

      @Stability(Stable) public void setDefaultCapacityProviderStrategy(@Nullable IResolvable value)
      The default capacity provider strategy for the cluster.

      When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

    • setDefaultCapacityProviderStrategy

      @Stability(Stable) public void setDefaultCapacityProviderStrategy(@Nullable List<Object> value)
      The default capacity provider strategy for the cluster.

      When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

    • getServiceConnectDefaults

      @Stability(Stable) @Nullable public Object getServiceConnectDefaults()
      Use this parameter to set a default Service Connect namespace.

      After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration . You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

    • setServiceConnectDefaults

      @Stability(Stable) public void setServiceConnectDefaults(@Nullable IResolvable value)
      Use this parameter to set a default Service Connect namespace.

      After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration . You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

    • setServiceConnectDefaults

      @Stability(Stable) public void setServiceConnectDefaults(@Nullable CfnCluster.ServiceConnectDefaultsProperty value)
      Use this parameter to set a default Service Connect namespace.

      After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration . You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .