Class: AWSCDK::ECS::CfnCluster::ExecuteCommandLogConfigurationProperty

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

Overview

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

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cloud_watch_encryption_enabled: nil, cloud_watch_log_group_name: nil, s3_bucket_name: nil, s3_encryption_enabled: nil, s3_key_prefix: nil) ⇒ ExecuteCommandLogConfigurationProperty

Returns a new instance of ExecuteCommandLogConfigurationProperty.

Parameters:

  • cloud_watch_encryption_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Determines whether to use encryption on the CloudWatch logs.

  • cloud_watch_log_group_name (String, nil) (defaults to: nil) —

    The name of the CloudWatch log group to send logs to.

  • s3_bucket_name (String, nil) (defaults to: nil) —

    The name of the S3 bucket to send logs to.

  • s3_encryption_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Determines whether to use encryption on the S3 logs.

  • s3_key_prefix (String, nil) (defaults to: nil) —

    An optional folder in the S3 bucket to place logs in.



877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'ecs/cfn_cluster.rb', line 877

def initialize(cloud_watch_encryption_enabled: nil, cloud_watch_log_group_name: nil, s3_bucket_name: nil, s3_encryption_enabled: nil, s3_key_prefix: nil)
  @cloud_watch_encryption_enabled = cloud_watch_encryption_enabled
  Jsii::Type.check_type(@cloud_watch_encryption_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "cloudWatchEncryptionEnabled") unless @cloud_watch_encryption_enabled.nil?
  @cloud_watch_log_group_name = cloud_watch_log_group_name
  Jsii::Type.check_type(@cloud_watch_log_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cloudWatchLogGroupName") unless @cloud_watch_log_group_name.nil?
  @s3_bucket_name = s3_bucket_name
  Jsii::Type.check_type(@s3_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName") unless @s3_bucket_name.nil?
  @s3_encryption_enabled = s3_encryption_enabled
  Jsii::Type.check_type(@s3_encryption_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "s3EncryptionEnabled") unless @s3_encryption_enabled.nil?
  @s3_key_prefix = s3_key_prefix
  Jsii::Type.check_type(@s3_key_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3KeyPrefix") unless @s3_key_prefix.nil?
end

Instance Attribute Details

#cloud_watch_encryption_enabled ⇒ Boolean, ... (readonly)

Determines whether to use encryption on the CloudWatch logs.

If not specified, encryption will be off.

Returns:

See Also:



896
897
898
 
# File 'ecs/cfn_cluster.rb', line 896

def cloud_watch_encryption_enabled
  @cloud_watch_encryption_enabled
end

#cloud_watch_log_group_name ⇒ String? (readonly)

The name of the CloudWatch log group to send logs to.

The CloudWatch log group must already be created.

Returns:

  • (String, nil)

See Also:



903
904
905
 
# File 'ecs/cfn_cluster.rb', line 903

def cloud_watch_log_group_name
  @cloud_watch_log_group_name
end

#s3_bucket_name ⇒ String? (readonly)

The name of the S3 bucket to send logs to.

The S3 bucket must already be created.

Returns:

  • (String, nil)

See Also:



910
911
912
 
# File 'ecs/cfn_cluster.rb', line 910

def s3_bucket_name
  @s3_bucket_name
end

#s3_encryption_enabled ⇒ Boolean, ... (readonly)

Determines whether to use encryption on the S3 logs.

If not specified, encryption is not used.

Returns:

See Also:



917
918
919
 
# File 'ecs/cfn_cluster.rb', line 917

def s3_encryption_enabled
  @s3_encryption_enabled
end

#s3_key_prefix ⇒ String? (readonly)

An optional folder in the S3 bucket to place logs in.

Returns:

  • (String, nil)

See Also:



922
923
924
 
# File 'ecs/cfn_cluster.rb', line 922

def s3_key_prefix
  @s3_key_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



924
925
926
927
928
929
930
931
932
 
# File 'ecs/cfn_cluster.rb', line 924

def self.jsii_properties
  {
    :cloud_watch_encryption_enabled => "cloudWatchEncryptionEnabled",
    :cloud_watch_log_group_name => "cloudWatchLogGroupName",
    :s3_bucket_name => "s3BucketName",
    :s3_encryption_enabled => "s3EncryptionEnabled",
    :s3_key_prefix => "s3KeyPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



934
935
936
937
938
939
940
941
942
943
944
 
# File 'ecs/cfn_cluster.rb', line 934

def to_jsii
  result = {}
  result.merge!({
    "cloudWatchEncryptionEnabled" => @cloud_watch_encryption_enabled,
    "cloudWatchLogGroupName" => @cloud_watch_log_group_name,
    "s3BucketName" => @s3_bucket_name,
    "s3EncryptionEnabled" => @s3_encryption_enabled,
    "s3KeyPrefix" => @s3_key_prefix,
  })
  result.compact
end