software.amazon.awscdk.services.ecs

Interface CfnCluster.ExecuteCommandConfigurationProperty

All Known Implementing Classes:

CfnCluster.ExecuteCommandConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnCluster

public static interface CfnCluster.ExecuteCommandConfigurationProperty

The details of the execute command configuration.

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.*;
 ExecuteCommandConfigurationProperty executeCommandConfigurationProperty = ExecuteCommandConfigurationProperty.builder()
         .kmsKeyId("kmsKeyId")
         .logConfiguration(ExecuteCommandLogConfigurationProperty.builder()
                 .cloudWatchEncryptionEnabled(false)
                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                 .s3BucketName("s3BucketName")
                 .s3EncryptionEnabled(false)
                 .s3KeyPrefix("s3KeyPrefix")
                 .build())
         .logging("logging")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCluster.ExecuteCommandConfigurationProperty.Builder	builder()
default java.lang.String	getKmsKeyId() Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
default java.lang.Object	getLogConfiguration() The log configuration for the results of the execute command actions.
default java.lang.String	getLogging() The log setting to use for redirecting logs for your execute command results.

Method Detail

getKmsKeyId

default java.lang.String getKmsKeyId()

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

getLogConfiguration

default java.lang.Object getLogConfiguration()

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.

getLogging

default java.lang.String getLogging()

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.

builder

static CfnCluster.ExecuteCommandConfigurationProperty.Builder builder()

Returns:

a CfnCluster.ExecuteCommandConfigurationProperty.Builder of CfnCluster.ExecuteCommandConfigurationProperty