CfnClusterPropsMixin

class aws_cdk.mixins_preview.aws_ecs.mixins.CfnClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource:

AWS::ECS::Cluster

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

cfn_cluster_props_mixin = ecs_mixins.CfnClusterPropsMixin(ecs_mixins.CfnClusterMixinProps(
    capacity_providers=["capacityProviders"],
    cluster_name="clusterName",
    cluster_settings=[ecs_mixins.CfnClusterPropsMixin.ClusterSettingsProperty(
        name="name",
        value="value"
    )],
    configuration=ecs_mixins.CfnClusterPropsMixin.ClusterConfigurationProperty(
        execute_command_configuration=ecs_mixins.CfnClusterPropsMixin.ExecuteCommandConfigurationProperty(
            kms_key_id="kmsKeyId",
            log_configuration=ecs_mixins.CfnClusterPropsMixin.ExecuteCommandLogConfigurationProperty(
                cloud_watch_encryption_enabled=False,
                cloud_watch_log_group_name="cloudWatchLogGroupName",
                s3_bucket_name="s3BucketName",
                s3_encryption_enabled=False,
                s3_key_prefix="s3KeyPrefix"
            ),
            logging="logging"
        ),
        managed_storage_configuration=ecs_mixins.CfnClusterPropsMixin.ManagedStorageConfigurationProperty(
            fargate_ephemeral_storage_kms_key_id="fargateEphemeralStorageKmsKeyId",
            kms_key_id="kmsKeyId"
        )
    ),
    default_capacity_provider_strategy=[ecs_mixins.CfnClusterPropsMixin.CapacityProviderStrategyItemProperty(
        base=123,
        capacity_provider="capacityProvider",
        weight=123
    )],
    service_connect_defaults=ecs_mixins.CfnClusterPropsMixin.ServiceConnectDefaultsProperty(
        namespace="namespace"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ECS::Cluster.

Parameters:
  • props (Union[CfnClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['capacityProviders', 'clusterName', 'clusterSettings', 'configuration', 'defaultCapacityProviderStrategy', 'serviceConnectDefaults', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

CapacityProviderStrategyItemProperty

class CfnClusterPropsMixin.CapacityProviderStrategyItemProperty(*, base=None, capacity_provider=None, weight=None)

Bases: object

The CapacityProviderStrategyItem property specifies the details of 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.

Parameters:
  • base (Union[int, float, None]) – The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. Base value characteristics: - Only one capacity provider in a strategy can have a base defined - The default value is 0 if not specified - The valid range is 0 to 100,000 - Base requirements are satisfied first before weight distribution

  • capacity_provider (Optional[str]) – The short name of the capacity provider. This can be either an AWS managed capacity provider ( FARGATE or FARGATE_SPOT ) or the name of a custom capacity provider that you created.

  • weight (Union[int, float, None]) – The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail. Weight value characteristics: - Weight is considered after the base value is satisfied - The default value is 0 if not specified - The valid range is 0 to 1,000 - At least one capacity provider must have a weight greater than zero - Capacity providers with weight of 0 cannot place tasks Task distribution logic: - Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider - Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios Examples: Equal Distribution: Two capacity providers both with weight 1 will split tasks evenly after base requirements are met. Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4 , then for every 1 task on A, 4 tasks will run on B.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

capacity_provider_strategy_item_property = ecs_mixins.CfnClusterPropsMixin.CapacityProviderStrategyItemProperty(
    base=123,
    capacity_provider="capacityProvider",
    weight=123
)

Attributes

base

The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.

Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

Base value characteristics:

  • Only one capacity provider in a strategy can have a base defined

  • The default value is 0 if not specified

  • The valid range is 0 to 100,000

  • Base requirements are satisfied first before weight distribution

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base

capacity_provider

The short name of the capacity provider.

This can be either an AWS managed capacity provider ( FARGATE or FARGATE_SPOT ) or the name of a custom capacity provider that you created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider

weight

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

Weight value characteristics:

  • Weight is considered after the base value is satisfied

  • The default value is 0 if not specified

  • The valid range is 0 to 1,000

  • At least one capacity provider must have a weight greater than zero

  • Capacity providers with weight of 0 cannot place tasks

Task distribution logic:

  • Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider

  • Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios

Examples:

Equal Distribution: Two capacity providers both with weight 1 will split tasks evenly after base requirements are met.

Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4 , then for every 1 task on A, 4 tasks will run on B.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-weight

ClusterConfigurationProperty

class CfnClusterPropsMixin.ClusterConfigurationProperty(*, execute_command_configuration=None, managed_storage_configuration=None)

Bases: object

The execute command and managed storage configuration for the cluster.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

cluster_configuration_property = ecs_mixins.CfnClusterPropsMixin.ClusterConfigurationProperty(
    execute_command_configuration=ecs_mixins.CfnClusterPropsMixin.ExecuteCommandConfigurationProperty(
        kms_key_id="kmsKeyId",
        log_configuration=ecs_mixins.CfnClusterPropsMixin.ExecuteCommandLogConfigurationProperty(
            cloud_watch_encryption_enabled=False,
            cloud_watch_log_group_name="cloudWatchLogGroupName",
            s3_bucket_name="s3BucketName",
            s3_encryption_enabled=False,
            s3_key_prefix="s3KeyPrefix"
        ),
        logging="logging"
    ),
    managed_storage_configuration=ecs_mixins.CfnClusterPropsMixin.ManagedStorageConfigurationProperty(
        fargate_ephemeral_storage_kms_key_id="fargateEphemeralStorageKmsKeyId",
        kms_key_id="kmsKeyId"
    )
)

Attributes

execute_command_configuration

The details of the execute command configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-executecommandconfiguration

managed_storage_configuration

The details of the managed storage configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html#cfn-ecs-cluster-clusterconfiguration-managedstorageconfiguration

ClusterSettingsProperty

class CfnClusterPropsMixin.ClusterSettingsProperty(*, name=None, value=None)

Bases: object

The settings to use when creating a cluster.

This parameter is used to turn on CloudWatch Container Insights with enhanced observability or CloudWatch Container Insights for a cluster.

Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.

For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide .

Parameters:
  • name (Optional[str]) – The name of the cluster setting. The value is containerInsights .

  • value (Optional[str]) – The value to set for the cluster setting. The supported values are enhanced , enabled , and disabled . To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced . To use Container Insights, set the containerInsights account setting to enabled . If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

cluster_settings_property = ecs_mixins.CfnClusterPropsMixin.ClusterSettingsProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the cluster setting.

The value is containerInsights .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-name

value

The value to set for the cluster setting. The supported values are enhanced , enabled , and disabled .

To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced .

To use Container Insights, set the containerInsights account setting to enabled .

If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html#cfn-ecs-cluster-clustersettings-value

ExecuteCommandConfigurationProperty

class CfnClusterPropsMixin.ExecuteCommandConfigurationProperty(*, kms_key_id=None, log_configuration=None, logging=None)

Bases: object

The details of the execute command configuration.

Parameters:
  • kms_key_id (Optional[str]) – Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.

  • log_configuration (Union[IResolvable, ExecuteCommandLogConfigurationProperty, Dict[str, Any], None]) – The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

  • logging (Optional[str]) – The log setting to use for redirecting logs for your execute command results. The following log settings are available. - NONE : The execute command session is not logged. - DEFAULT : The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won’t be logged. - OVERRIDE : Specify the logging details as a part of logConfiguration . If the OVERRIDE logging option is specified, the logConfiguration is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

execute_command_configuration_property = ecs_mixins.CfnClusterPropsMixin.ExecuteCommandConfigurationProperty(
    kms_key_id="kmsKeyId",
    log_configuration=ecs_mixins.CfnClusterPropsMixin.ExecuteCommandLogConfigurationProperty(
        cloud_watch_encryption_enabled=False,
        cloud_watch_log_group_name="cloudWatchLogGroupName",
        s3_bucket_name="s3BucketName",
        s3_encryption_enabled=False,
        s3_key_prefix="s3KeyPrefix"
    ),
    logging="logging"
)

Attributes

kms_key_id

Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-kmskeyid

log_configuration

The log configuration for the results of the execute command actions.

The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logconfiguration

logging

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

  • NONE : The execute command session is not logged.

  • DEFAULT : The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won’t be logged.

  • OVERRIDE : Specify the logging details as a part of logConfiguration . If the OVERRIDE logging option is specified, the logConfiguration is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging

ExecuteCommandLogConfigurationProperty

class CfnClusterPropsMixin.ExecuteCommandLogConfigurationProperty(*, cloud_watch_encryption_enabled=None, cloud_watch_log_group_name=None, s3_bucket_name=None, s3_encryption_enabled=None, s3_key_prefix=None)

Bases: object

The log configuration for the results of the execute command actions.

The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

Parameters:
  • cloud_watch_encryption_enabled (Union[bool, IResolvable, None]) – Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

  • cloud_watch_log_group_name (Optional[str]) – The name of the CloudWatch log group to send logs to. .. epigraph:: The CloudWatch log group must already be created.

  • s3_bucket_name (Optional[str]) – The name of the S3 bucket to send logs to. .. epigraph:: The S3 bucket must already be created.

  • s3_encryption_enabled (Union[bool, IResolvable, None]) – Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

  • s3_key_prefix (Optional[str]) – An optional folder in the S3 bucket to place logs in.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

execute_command_log_configuration_property = ecs_mixins.CfnClusterPropsMixin.ExecuteCommandLogConfigurationProperty(
    cloud_watch_encryption_enabled=False,
    cloud_watch_log_group_name="cloudWatchLogGroupName",
    s3_bucket_name="s3BucketName",
    s3_encryption_enabled=False,
    s3_key_prefix="s3KeyPrefix"
)

Attributes

cloud_watch_encryption_enabled

Determines whether to use encryption on the CloudWatch logs.

If not specified, encryption will be off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchencryptionenabled

cloud_watch_log_group_name

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-cloudwatchloggroupname

s3_bucket_name

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3bucketname

s3_encryption_enabled

Determines whether to use encryption on the S3 logs.

If not specified, encryption is not used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3encryptionenabled

s3_key_prefix

An optional folder in the S3 bucket to place logs in.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html#cfn-ecs-cluster-executecommandlogconfiguration-s3keyprefix

ManagedStorageConfigurationProperty

class CfnClusterPropsMixin.ManagedStorageConfigurationProperty(*, fargate_ephemeral_storage_kms_key_id=None, kms_key_id=None)

Bases: object

The managed storage configuration for the cluster.

Parameters:
  • fargate_ephemeral_storage_kms_key_id (Optional[str]) – Specify the AWS Key Management Service key ID for Fargate ephemeral storage. When you specify a fargateEphemeralStorageKmsKeyId , AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for AWS Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide . The key must be a single Region key.

  • kms_key_id (Optional[str]) – Specify a AWS Key Management Service key ID to encrypt Amazon ECS managed storage. When you specify a kmsKeyId , Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide . The key must be a single Region key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

managed_storage_configuration_property = ecs_mixins.CfnClusterPropsMixin.ManagedStorageConfigurationProperty(
    fargate_ephemeral_storage_kms_key_id="fargateEphemeralStorageKmsKeyId",
    kms_key_id="kmsKeyId"
)

Attributes

fargate_ephemeral_storage_kms_key_id

Specify the AWS Key Management Service key ID for Fargate ephemeral storage.

When you specify a fargateEphemeralStorageKmsKeyId , AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for AWS Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide .

The key must be a single Region key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html#cfn-ecs-cluster-managedstorageconfiguration-fargateephemeralstoragekmskeyid

kms_key_id

Specify a AWS Key Management Service key ID to encrypt Amazon ECS managed storage.

When you specify a kmsKeyId , Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide .

The key must be a single Region key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html#cfn-ecs-cluster-managedstorageconfiguration-kmskeyid

ServiceConnectDefaultsProperty

class CfnClusterPropsMixin.ServiceConnectDefaultsProperty(*, namespace=None)

Bases: object

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 .

Parameters:

namespace (Optional[str]) – The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace that’s used when you create a service and don’t specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can’t include greater than (>), less than (<), double quotation marks (“), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a AWS Cloud Map namespace will be created. Amazon ECS creates a AWS Cloud Map namespace with the “API calls” method of instance discovery only. This instance discovery method is the “HTTP” namespace type in the AWS Command Line Interface . Other types of instance discovery aren’t used by Service Connect. If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in AWS Cloud Map and must be deleted separately. For more information about AWS Cloud Map , see Working with Services in the AWS Cloud Map Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ecs import mixins as ecs_mixins

service_connect_defaults_property = ecs_mixins.CfnClusterPropsMixin.ServiceConnectDefaultsProperty(
    namespace="namespace"
)

Attributes

namespace

The namespace name or full Amazon Resource Name (ARN) of the AWS Cloud Map namespace that’s used when you create a service and don’t specify a Service Connect configuration.

The namespace name can include up to 1024 characters. The name is case-sensitive. The name can’t include greater than (>), less than (<), double quotation marks (“), or slash (/).

If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.

If you enter a new name, a AWS Cloud Map namespace will be created. Amazon ECS creates a AWS Cloud Map namespace with the “API calls” method of instance discovery only. This instance discovery method is the “HTTP” namespace type in the AWS Command Line Interface . Other types of instance discovery aren’t used by Service Connect.

If you update the cluster with an empty string "" for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in AWS Cloud Map and must be deleted separately.

For more information about AWS Cloud Map , see Working with Services in the AWS Cloud Map Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html#cfn-ecs-cluster-serviceconnectdefaults-namespace