Class: AWSCDK::NotificationsContacts::CfnEmailContact::EmailContactProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::NotificationsContacts::CfnEmailContact::EmailContactProperty

Defined in:

notifications_contacts/cfn_email_contact.rb

Overview

Configures email contacts for AWS User Notifications .

You must activate the email contact using the activation token that you will receive when the email contact is set up.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html

Instance Attribute Summary

• #address ⇒ String readonly

  The email address of the contact.

• #arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the contact.

• #creation_time ⇒ String readonly

  The creation time of the EmailContact .

• #name ⇒ String readonly

  The name of the contact.

• #status ⇒ String readonly

  The status of the contact.

• #update_time ⇒ String readonly

  The time the EmailContact was last updated.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(address:, arn:, creation_time:, name:, status:, update_time:) ⇒ EmailContactProperty constructor

  A new instance of EmailContactProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(address:, arn:, creation_time:, name:, status:, update_time:) ⇒ EmailContactProperty

Returns a new instance of EmailContactProperty.

Parameters:

• address (String) —

  The email address of the contact.

• arn (String) —

  The Amazon Resource Name (ARN) of the contact.

• creation_time (String) —

  The creation time of the EmailContact .

• name (String) —

  The name of the contact.

• status (String) —

  The status of the contact.

• update_time (String) —

  The time the EmailContact was last updated.

# File 'notifications_contacts/cfn_email_contact.rb', line 606

def initialize(address:, arn:, creation_time:, name:, status:, update_time:)
  @address = address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "address")
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  @creation_time = creation_time
  Jsii::Type.check_type(@creation_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "creationTime")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @update_time = update_time
  Jsii::Type.check_type(@update_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "updateTime")
end

Instance Attribute Details

#address ⇒ String (readonly)

The email address of the contact.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-address

# File 'notifications_contacts/cfn_email_contact.rb', line 625

def address
  @address
end

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the contact.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-arn

# File 'notifications_contacts/cfn_email_contact.rb', line 630

def arn
  @arn
end

#creation_time ⇒ String (readonly)

The creation time of the EmailContact .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-creationtime

# File 'notifications_contacts/cfn_email_contact.rb', line 635

def creation_time
  @creation_time
end

#name ⇒ String (readonly)

The name of the contact.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-name

# File 'notifications_contacts/cfn_email_contact.rb', line 640

def name
  @name
end

#status ⇒ String (readonly)

The status of the contact.

Only activated contacts receive emails.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-status

# File 'notifications_contacts/cfn_email_contact.rb', line 647

def status
  @status
end

#update_time ⇒ String (readonly)

The time the EmailContact was last updated.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-notificationscontacts-emailcontact-emailcontact.html#cfn-notificationscontacts-emailcontact-emailcontact-updatetime

# File 'notifications_contacts/cfn_email_contact.rb', line 652

def update_time
  @update_time
end

Class Method Details

.jsii_properties ⇒ Object

# File 'notifications_contacts/cfn_email_contact.rb', line 654

def self.jsii_properties
  {
    :address => "address",
    :arn => "arn",
    :creation_time => "creationTime",
    :name => "name",
    :status => "status",
    :update_time => "updateTime",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'notifications_contacts/cfn_email_contact.rb', line 665

def to_jsii
  result = {}
  result.merge!({
    "address" => @address,
    "arn" => @arn,
    "creationTime" => @creation_time,
    "name" => @name,
    "status" => @status,
    "updateTime" => @update_time,
  })
  result.compact
end