Class: AWSCDK::B2BI::CfnPartnershipProps

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

Overview

Properties for defining a CfnPartnership.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(capabilities:, email:, name:, profile_id:, capability_options: nil, phone: nil, tags: nil) ⇒ CfnPartnershipProps

Returns a new instance of CfnPartnershipProps.

Parameters:

  • capabilities (Array<String>) —

    Returns one or more capabilities associated with this partnership.

  • email (String) —

    Specifies the email address associated with this trading partner.

  • name (String) —

    Returns the name of the partnership.

  • profile_id (String) —

    Returns the unique, system-generated identifier for the profile connected to this partnership.

  • capability_options (AWSCDK::IResolvable, AWSCDK::B2BI::CfnPartnership::CapabilityOptionsProperty, nil) (defaults to: nil) —

    Contains the details for an Outbound EDI capability.

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

    Specifies the phone number associated with the partnership.

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

    A key-value pair for a specific partnership.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'b2_bi/cfn_partnership_props.rb', line 16

def initialize(capabilities:, email:, name:, profile_id:, capability_options: nil, phone: nil, tags: nil)
  @capabilities = capabilities
  Jsii::Type.check_type(@capabilities, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "capabilities")
  @email = email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "email")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @profile_id = profile_id
  Jsii::Type.check_type(@profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "profileId")
  @capability_options = capability_options.is_a?(Hash) ? ::AWSCDK::B2BI::CfnPartnership::CapabilityOptionsProperty.new(**capability_options.transform_keys(&:to_sym)) : capability_options
  Jsii::Type.check_type(@capability_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblBhcnRuZXJzaGlwLkNhcGFiaWxpdHlPcHRpb25zUHJvcGVydHkifV19fQ==")), "capabilityOptions") unless @capability_options.nil?
  @phone = phone
  Jsii::Type.check_type(@phone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "phone") unless @phone.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

#capabilities ⇒ Array<String> (readonly)

Returns one or more capabilities associated with this partnership.

Returns:

  • (Array<String>)

See Also:



37
38
39
 
# File 'b2_bi/cfn_partnership_props.rb', line 37

def capabilities
  @capabilities
end

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

Contains the details for an Outbound EDI capability.

Returns:

See Also:



57
58
59
 
# File 'b2_bi/cfn_partnership_props.rb', line 57

def capability_options
  @capability_options
end

#email ⇒ String (readonly)

Specifies the email address associated with this trading partner.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'b2_bi/cfn_partnership_props.rb', line 42

def email
  @email
end

#name ⇒ String (readonly)

Returns the name of the partnership.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'b2_bi/cfn_partnership_props.rb', line 47

def name
  @name
end

#phone ⇒ String? (readonly)

Specifies the phone number associated with the partnership.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'b2_bi/cfn_partnership_props.rb', line 62

def phone
  @phone
end

#profile_id ⇒ String (readonly)

Returns the unique, system-generated identifier for the profile connected to this partnership.

Returns:

  • (String)

See Also:



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

def profile_id
  @profile_id
end

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

A key-value pair for a specific partnership.

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

Returns:

See Also:



69
70
71
 
# File 'b2_bi/cfn_partnership_props.rb', line 69

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'b2_bi/cfn_partnership_props.rb', line 71

def self.jsii_properties
  {
    :capabilities => "capabilities",
    :email => "email",
    :name => "name",
    :profile_id => "profileId",
    :capability_options => "capabilityOptions",
    :phone => "phone",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'b2_bi/cfn_partnership_props.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "capabilities" => @capabilities,
    "email" => @email,
    "name" => @name,
    "profileId" => @profile_id,
    "capabilityOptions" => @capability_options,
    "phone" => @phone,
    "tags" => @tags,
  })
  result.compact
end