Class: AWSCDK::Connect::CfnEmailAddressProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_email_address_props.rb

Overview

Properties for defining a CfnEmailAddress.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_address:, instance_arn:, alias_configurations: nil, description: nil, display_name: nil, tags: nil) ⇒ CfnEmailAddressProps

Returns a new instance of CfnEmailAddressProps.

Parameters:

  • email_address (String) —

    The email address, including the domain.

  • instance_arn (String) —

    The Amazon Resource Name (ARN) of the instance.

  • alias_configurations (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Connect::CfnEmailAddress::AliasConfigurationProperty>, nil) (defaults to: nil) —

    A list of alias configurations for this email address, showing which email addresses forward to this primary address.

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

    The description of the email address.

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

    The display name of email address.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'connect/cfn_email_address_props.rb', line 15

def initialize(email_address:, instance_arn:, alias_configurations: nil, description: nil, display_name: nil, tags: nil)
  @email_address = email_address
  Jsii::Type.check_type(@email_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailAddress")
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @alias_configurations = alias_configurations
  Jsii::Type.check_type(@alias_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5FbWFpbEFkZHJlc3MuQWxpYXNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "aliasConfigurations") unless @alias_configurations.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#alias_configurations ⇒ AWSCDK::IResolvable, ... (readonly)

A list of alias configurations for this email address, showing which email addresses forward to this primary address.

Each configuration contains the email address ID of an alias that forwards emails to this address.

Returns:

See Also:



46
47
48
 
# File 'connect/cfn_email_address_props.rb', line 46

def alias_configurations
  @alias_configurations
end

#description ⇒ String? (readonly)

The description of the email address.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'connect/cfn_email_address_props.rb', line 51

def description
  @description
end

#display_name ⇒ String? (readonly)

The display name of email address.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'connect/cfn_email_address_props.rb', line 56

def display_name
  @display_name
end

#email_address ⇒ String (readonly)

The email address, including the domain.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'connect/cfn_email_address_props.rb', line 34

def email_address
  @email_address
end

#instance_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'connect/cfn_email_address_props.rb', line 39

def instance_arn
  @instance_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Returns:

See Also:



61
62
63
 
# File 'connect/cfn_email_address_props.rb', line 61

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'connect/cfn_email_address_props.rb', line 63

def self.jsii_properties
  {
    :email_address => "emailAddress",
    :instance_arn => "instanceArn",
    :alias_configurations => "aliasConfigurations",
    :description => "description",
    :display_name => "displayName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'connect/cfn_email_address_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "emailAddress" => @email_address,
    "instanceArn" => @instance_arn,
    "aliasConfigurations" => @alias_configurations,
    "description" => @description,
    "displayName" => @display_name,
    "tags" => @tags,
  })
  result.compact
end