Class: AWSCDK::ECS::ExecuteCommandConfiguration

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/execute_command_configuration.rb

Overview

The details of the execute command configuration.

For more information, see [ExecuteCommandConfiguration] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(kms_key: nil, log_configuration: nil, logging: nil) ⇒ ExecuteCommandConfiguration

Returns a new instance of ExecuteCommandConfiguration.

Parameters:



13
14
15
16
17
18
19
20
 
# File 'ecs/execute_command_configuration.rb', line 13

def initialize(kms_key: nil, log_configuration: nil, logging: nil)
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "kmsKey") unless @kms_key.nil?
  @log_configuration = log_configuration.is_a?(Hash) ? ::AWSCDK::ECS::ExecuteCommandLogConfiguration.new(**log_configuration.transform_keys(&:to_sym)) : log_configuration
  Jsii::Type.check_type(@log_configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkV4ZWN1dGVDb21tYW5kTG9nQ29uZmlndXJhdGlvbiJ9")), "logConfiguration") unless @log_configuration.nil?
  @logging = logging
  Jsii::Type.check_type(@logging, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkV4ZWN1dGVDb21tYW5kTG9nZ2luZyJ9")), "logging") unless @logging.nil?
end

Instance Attribute Details

#kms_key ⇒ AWSCDK::KMS::IKey? (readonly)

Note:

Default: - none

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

Returns:



26
27
28
 
# File 'ecs/execute_command_configuration.rb', line 26

def kms_key
  @kms_key
end

#log_configuration ⇒ AWSCDK::ECS::ExecuteCommandLogConfiguration? (readonly)

Note:

Default: - none

The log configuration for the results of the execute command actions.

The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

Returns:



33
34
35
 
# File 'ecs/execute_command_configuration.rb', line 33

def log_configuration
  @log_configuration
end

#logging ⇒ AWSCDK::ECS::ExecuteCommandLogging? (readonly)

Note:

Default: - none

The log settings to use for logging the execute command session.

Returns:



38
39
40
 
# File 'ecs/execute_command_configuration.rb', line 38

def logging
  @logging
end

Class Method Details

.jsii_properties ⇒ Object 



40
41
42
43
44
45
46
 
# File 'ecs/execute_command_configuration.rb', line 40

def self.jsii_properties
  {
    :kms_key => "kmsKey",
    :log_configuration => "logConfiguration",
    :logging => "logging",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'ecs/execute_command_configuration.rb', line 48

def to_jsii
  result = {}
  result.merge!({
    "kmsKey" => @kms_key,
    "logConfiguration" => @log_configuration,
    "logging" => @logging,
  })
  result.compact
end