Class: Aws::ECS::Types::ExecuteCommandConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ExecuteCommandConfiguration data as a hash:

{
  kms_key_id: "String",
  logging: "NONE", # accepts NONE, DEFAULT, OVERRIDE
  log_configuration: {
    cloud_watch_log_group_name: "String",
    cloud_watch_encryption_enabled: false,
    s3_bucket_name: "String",
    s3_encryption_enabled: false,
    s3_key_prefix: "String",
  },
}

The details of the execute command configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_idString

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

Returns:

  • (String)

4908
4909
4910
4911
4912
4913
4914
# File 'lib/aws-sdk-ecs/types.rb', line 4908

class ExecuteCommandConfiguration < Struct.new(
  :kms_key_id,
  :logging,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#log_configurationTypes::ExecuteCommandLogConfiguration

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.


4908
4909
4910
4911
4912
4913
4914
# File 'lib/aws-sdk-ecs/types.rb', line 4908

class ExecuteCommandConfiguration < Struct.new(
  :kms_key_id,
  :logging,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#loggingString

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.

Returns:

  • (String)

4908
4909
4910
4911
4912
4913
4914
# File 'lib/aws-sdk-ecs/types.rb', line 4908

class ExecuteCommandConfiguration < Struct.new(
  :kms_key_id,
  :logging,
  :log_configuration)
  SENSITIVE = []
  include Aws::Structure
end