Class: AWSCDK::ECS::CfnCluster::ServiceConnectDefaultsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/cfn_cluster.rb

Overview

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 .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace: nil) ⇒ ServiceConnectDefaultsProperty

Returns a new instance of ServiceConnectDefaultsProperty.

Parameters:

  • namespace (String, nil) (defaults to: nil) —

    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.



1009
1010
1011
1012
 
# File 'ecs/cfn_cluster.rb', line 1009

def initialize(namespace: nil)
  @namespace = namespace
  Jsii::Type.check_type(@namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespace") unless @namespace.nil?
end

Instance Attribute Details

#namespace ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



1028
1029
1030
 
# File 'ecs/cfn_cluster.rb', line 1028

def namespace
  @namespace
end

Class Method Details

.jsii_properties ⇒ Object 



1030
1031
1032
1033
1034
 
# File 'ecs/cfn_cluster.rb', line 1030

def self.jsii_properties
  {
    :namespace => "namespace",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1036
1037
1038
1039
1040
1041
1042
 
# File 'ecs/cfn_cluster.rb', line 1036

def to_jsii
  result = {}
  result.merge!({
    "namespace" => @namespace,
  })
  result.compact
end