Class: AWSCDK::B2BI::CfnCapabilityProps

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

Overview

Properties for defining a CfnCapability.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration:, name:, type:, instructions_documents: nil, tags: nil) ⇒ CfnCapabilityProps

Returns a new instance of CfnCapabilityProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
# File 'b2_bi/cfn_capability_props.rb', line 14

def initialize(configuration:, name:, type:, instructions_documents: nil, tags: nil)
  @configuration = configuration.is_a?(Hash) ? ::AWSCDK::B2BI::CfnCapability::CapabilityConfigurationProperty.new(**configuration.transform_keys(&:to_sym)) : configuration
  Jsii::Type.check_type(@configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmbkNhcGFiaWxpdHkuQ2FwYWJpbGl0eUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "configuration")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @instructions_documents = instructions_documents
  Jsii::Type.check_type(@instructions_documents, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYjJiaS5DZm5DYXBhYmlsaXR5LlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "instructionsDocuments") unless @instructions_documents.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

#configurationAWSCDK::IResolvable, AWSCDK::B2BI::CfnCapability::CapabilityConfigurationProperty (readonly)

Specifies a structure that contains the details for a capability.



31
32
33
# File 'b2_bi/cfn_capability_props.rb', line 31

def configuration
  @configuration
end

#instructions_documentsAWSCDK::IResolvable, ... (readonly)

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability.

Each item contains the name of the bucket and the key, to identify the document's location.



50
51
52
# File 'b2_bi/cfn_capability_props.rb', line 50

def instructions_documents
  @instructions_documents
end

#nameString (readonly)

The display name of the capability.



36
37
38
# File 'b2_bi/cfn_capability_props.rb', line 36

def name
  @name
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.

You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.



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

def tags
  @tags
end

#typeString (readonly)

Returns the type of the capability.

Currently, only edi is supported.



43
44
45
# File 'b2_bi/cfn_capability_props.rb', line 43

def type
  @type
end

Class Method Details

.jsii_propertiesObject



59
60
61
62
63
64
65
66
67
# File 'b2_bi/cfn_capability_props.rb', line 59

def self.jsii_properties
  {
    :configuration => "configuration",
    :name => "name",
    :type => "type",
    :instructions_documents => "instructionsDocuments",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



69
70
71
72
73
74
75
76
77
78
79
# File 'b2_bi/cfn_capability_props.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "configuration" => @configuration,
    "name" => @name,
    "type" => @type,
    "instructionsDocuments" => @instructions_documents,
    "tags" => @tags,
  })
  result.compact
end