Class: AWSCDK::B2BI::CfnProfileProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
b2_bi/cfn_profile_props.rb

Overview

Properties for defining a CfnProfile.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(business_name:, logging:, name:, phone:, email: nil, tags: nil) ⇒ CfnProfileProps

Returns a new instance of CfnProfileProps.

Parameters:

  • business_name (String) —

    Returns the name for the business associated with this profile.

  • logging (String) —

    Specifies whether or not logging is enabled for this profile.

  • name (String) —

    Returns the display name for profile.

  • phone (String) —

    Specifies the phone number associated with the profile.

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

    A key-value pair for a specific profile.



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

def initialize(business_name:, logging:, name:, phone:, email: nil, tags: nil)
  @business_name = business_name
  Jsii::Type.check_type(@business_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "businessName")
  @logging = logging
  Jsii::Type.check_type(@logging, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logging")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @phone = phone
  Jsii::Type.check_type(@phone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "phone")
  @email = email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "email") unless @email.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

#business_name ⇒ String (readonly)

Returns the name for the business associated with this profile.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'b2_bi/cfn_profile_props.rb', line 34

def business_name
  @business_name
end

#email ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'b2_bi/cfn_profile_props.rb', line 52

def email
  @email
end

#logging ⇒ String (readonly)

Specifies whether or not logging is enabled for this profile.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'b2_bi/cfn_profile_props.rb', line 39

def logging
  @logging
end

#name ⇒ String (readonly)

Returns the display name for profile.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'b2_bi/cfn_profile_props.rb', line 44

def name
  @name
end

#phone ⇒ String (readonly)

Specifies the phone number associated with the profile.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'b2_bi/cfn_profile_props.rb', line 49

def phone
  @phone
end

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

A key-value pair for a specific profile.

Tags are metadata that you can use to search for and group capabilities for various purposes.

Returns:

See Also:



59
60
61
 
# File 'b2_bi/cfn_profile_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'b2_bi/cfn_profile_props.rb', line 61

def self.jsii_properties
  {
    :business_name => "businessName",
    :logging => "logging",
    :name => "name",
    :phone => "phone",
    :email => "email",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'b2_bi/cfn_profile_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "businessName" => @business_name,
    "logging" => @logging,
    "name" => @name,
    "phone" => @phone,
    "email" => @email,
    "tags" => @tags,
  })
  result.compact
end