interface ExecuteCommandConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.ECS.CfnCluster.ExecuteCommandConfigurationProperty
Java	software.amazon.awscdk.services.ecs.CfnCluster.ExecuteCommandConfigurationProperty
Python	aws_cdk.aws_ecs.CfnCluster.ExecuteCommandConfigurationProperty
TypeScript	@aws-cdk/aws-ecs » 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 * as ecs from '@aws-cdk/aws-ecs';
const executeCommandConfigurationProperty: ecs.CfnCluster.ExecuteCommandConfigurationProperty = {
  kmsKeyId: 'kmsKeyId',
  logConfiguration: {
    cloudWatchEncryptionEnabled: false,
    cloudWatchLogGroupName: 'cloudWatchLogGroupName',
    s3BucketName: 's3BucketName',
    s3EncryptionEnabled: false,
    s3KeyPrefix: 's3KeyPrefix',
  },
  logging: 'logging',
};

Properties

Name	Type	Description
kmsKeyId?	string	Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
logConfiguration?	IResolvable | ExecuteCommandLogConfigurationProperty	The log configuration for the results of the execute command actions.
logging?	string	The log setting to use for redirecting logs for your execute command results. The following log settings are available.

---

kmsKeyId?

Type: string (optional)

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

---

logConfiguration?

Type: IResolvable | ExecuteCommandLogConfigurationProperty (optional)

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?

Type: string (optional)

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.