software.amazon.awscdk.services.ecs

Interface ClusterAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.675Z")
 @Stability(value=Stable)
public interface ClusterAttributes
extends software.amazon.jsii.JsiiSerializable

The properties to import from the 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.autoscaling.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.servicediscovery.*;
 AutoScalingGroup autoScalingGroup;
 Bucket bucket;
 Key key;
 LogGroup logGroup;
 INamespace namespace;
 SecurityGroup securityGroup;
 Vpc vpc;
 ClusterAttributes clusterAttributes = ClusterAttributes.builder()
         .clusterName("clusterName")
         .securityGroups(List.of(securityGroup))
         .vpc(vpc)
         // the properties below are optional
         .autoscalingGroup(autoScalingGroup)
         .clusterArn("clusterArn")
         .defaultCloudMapNamespace(namespace)
         .executeCommandConfiguration(ExecuteCommandConfiguration.builder()
                 .kmsKey(key)
                 .logConfiguration(ExecuteCommandLogConfiguration.builder()
                         .cloudWatchEncryptionEnabled(false)
                         .cloudWatchLogGroup(logGroup)
                         .s3Bucket(bucket)
                         .s3EncryptionEnabled(false)
                         .s3KeyPrefix("s3KeyPrefix")
                         .build())
                 .logging(ExecuteCommandLogging.NONE)
                 .build())
         .hasEc2Capacity(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClusterAttributes.Builder A builder for ClusterAttributes
static class	ClusterAttributes.Jsii$Proxy An implementation for ClusterAttributes

Method Summary

Modifier and Type	Method and Description
static ClusterAttributes.Builder	builder()
default IAutoScalingGroup	getAutoscalingGroup() Autoscaling group added to the cluster if capacity is added.
default String	getClusterArn() The Amazon Resource Name (ARN) that identifies the cluster.
String	getClusterName() The name of the cluster.
default INamespace	getDefaultCloudMapNamespace() The AWS Cloud Map namespace to associate with the cluster.
default ExecuteCommandConfiguration	getExecuteCommandConfiguration() The execute command configuration for the cluster.
default Boolean	getHasEc2Capacity() Specifies whether the cluster has EC2 instance capacity.
List<ISecurityGroup>	getSecurityGroups() The security groups associated with the container instances registered to the cluster.
IVpc	getVpc() The VPC associated with the cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterName

@Stability(value=Stable)
 @NotNull
String getClusterName()

The name of the cluster.

getSecurityGroups

@Stability(value=Stable)
 @NotNull
List<ISecurityGroup> getSecurityGroups()

The security groups associated with the container instances registered to the cluster.

getVpc

@Stability(value=Stable)
 @NotNull
IVpc getVpc()

The VPC associated with the cluster.

getAutoscalingGroup

@Stability(value=Stable)
 @Nullable
default IAutoScalingGroup getAutoscalingGroup()

Autoscaling group added to the cluster if capacity is added.

Default: - No default autoscaling group

getClusterArn

@Stability(value=Stable)
 @Nullable
default String getClusterArn()

The Amazon Resource Name (ARN) that identifies the cluster.

Default: Derived from clusterName

getDefaultCloudMapNamespace

@Stability(value=Stable)
 @Nullable
default INamespace getDefaultCloudMapNamespace()

The AWS Cloud Map namespace to associate with the cluster.

Default: - No default namespace

getExecuteCommandConfiguration

@Stability(value=Stable)
 @Nullable
default ExecuteCommandConfiguration getExecuteCommandConfiguration()

The execute command configuration for the cluster.

Default: - none.

getHasEc2Capacity

@Stability(value=Stable)
 @Nullable
default Boolean getHasEc2Capacity()

Specifies whether the cluster has EC2 instance capacity.

Default: true

builder

@Stability(value=Stable)
static ClusterAttributes.Builder builder()

Returns:

a ClusterAttributes.Builder of ClusterAttributes