Class: AWSCDK::Logs::CfnTransformer::RenameKeyEntryProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Logs::CfnTransformer::RenameKeyEntryProperty

Defined in:

logs/cfn_transformer.rb

Overview

This object defines one key that will be renamed with the renameKey processor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-renamekeyentry.html

Instance Attribute Summary

• #key ⇒ String readonly

  The key to rename.

• #overwrite_if_exists ⇒ Boolean, ... readonly

  Specifies whether to overwrite the existing value if the destination key already exists.

• #rename_to ⇒ String readonly

  The string to use for the new key name.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(key:, rename_to:, overwrite_if_exists: nil) ⇒ RenameKeyEntryProperty constructor

  A new instance of RenameKeyEntryProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(key:, rename_to:, overwrite_if_exists: nil) ⇒ RenameKeyEntryProperty

Returns a new instance of RenameKeyEntryProperty.

Parameters:

• key (String) —

  The key to rename.

• rename_to (String) —

  The string to use for the new key name.

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

  Specifies whether to overwrite the existing value if the destination key already exists.

# File 'logs/cfn_transformer.rb', line 1870

def initialize(key:, rename_to:, overwrite_if_exists: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @rename_to = rename_to
  Jsii::Type.check_type(@rename_to, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "renameTo")
  @overwrite_if_exists = overwrite_if_exists
  Jsii::Type.check_type(@overwrite_if_exists, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "overwriteIfExists") unless @overwrite_if_exists.nil?
end

Instance Attribute Details

#key ⇒ String (readonly)

The key to rename.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-renamekeyentry.html#cfn-logs-transformer-renamekeyentry-key

# File 'logs/cfn_transformer.rb', line 1883

def key
  @key
end

#overwrite_if_exists ⇒ Boolean, ... (readonly)

Specifies whether to overwrite the existing value if the destination key already exists.

The default is false

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-renamekeyentry.html#cfn-logs-transformer-renamekeyentry-overwriteifexists

# File 'logs/cfn_transformer.rb', line 1895

def overwrite_if_exists
  @overwrite_if_exists
end

#rename_to ⇒ String (readonly)

The string to use for the new key name.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-renamekeyentry.html#cfn-logs-transformer-renamekeyentry-renameto

# File 'logs/cfn_transformer.rb', line 1888

def rename_to
  @rename_to
end

Class Method Details

.jsii_properties ⇒ Object

# File 'logs/cfn_transformer.rb', line 1897

def self.jsii_properties
  {
    :key => "key",
    :rename_to => "renameTo",
    :overwrite_if_exists => "overwriteIfExists",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'logs/cfn_transformer.rb', line 1905

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "renameTo" => @rename_to,
    "overwriteIfExists" => @overwrite_if_exists,
  })
  result.compact
end