aws-cdk-lib.aws_ecs.CfnCluster.ExecuteCommandConfigurationProperty

ExecuteCommandConfigurationProperty Struct

The details of the execute command configuration.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const executeCommandConfigurationProperty: ecs.CfnCluster.ExecuteCommandConfigurationProperty = {
  kmsKeyId: 'kmsKeyId',
  logConfiguration: {
    cloudWatchEncryptionEnabled: false,
    cloudWatchLogGroupName: 'cloudWatchLogGroupName',
    s3BucketName: 's3BucketName',
    s3EncryptionEnabled: false,
    s3KeyPrefix: 's3KeyPrefix',
  },
  logging: 'logging',
};

Properties

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*string#

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

logConfiguration?optionalIResolvable | CfnCluster.ExecuteCommandLogConfigurationPropertylog_configuration?optionaltyping.Union[IResolvable, ExecuteCommandLogConfigurationProperty]logConfiguration?optionalIResolvableLogConfiguration?optionalIResolvableLogConfiguration?optionalinterface{}#

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?optionalstringlogging?optionalstrlogging?optionalStringLogging?optionalstringLogging?optional*string#

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

notes

• 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.