Class: AWSCDK::Transfer::CfnProfileProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/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(as2_id:, profile_type:, certificate_ids: nil, tags: nil) ⇒ CfnProfileProps

Returns a new instance of CfnProfileProps.

Parameters:

  • as2_id (String) —

    The As2Id is the AS2-name , as defined in the RFC 4130 . For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

  • profile_type (String) —

    Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.

  • certificate_ids (Array<String>, nil) (defaults to: nil) —

    An array of identifiers for the imported certificates.

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

    Key-value pairs that can be used to group and search for profiles.



13
14
15
16
17
18
19
20
21
22
 
# File 'transfer/cfn_profile_props.rb', line 13

def initialize(as2_id:, profile_type:, certificate_ids: nil, tags: nil)
  @as2_id = as2_id
  Jsii::Type.check_type(@as2_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "as2Id")
  @profile_type = profile_type
  Jsii::Type.check_type(@profile_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "profileType")
  @certificate_ids = certificate_ids
  Jsii::Type.check_type(@certificate_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "certificateIds") unless @certificate_ids.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

#as2_id ⇒ String (readonly)

The As2Id is the AS2-name , as defined in the RFC 4130 . For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'transfer/cfn_profile_props.rb', line 28

def as2_id
  @as2_id
end

#certificate_ids ⇒ Array<String>? (readonly)

An array of identifiers for the imported certificates.

You use this identifier for working with profiles and partner profiles.

Returns:

  • (Array<String>, nil)

See Also:



42
43
44
 
# File 'transfer/cfn_profile_props.rb', line 42

def certificate_ids
  @certificate_ids
end

#profile_type ⇒ String (readonly)

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.

If not supplied in the request, the command lists all types of profiles.

Returns:

  • (String)

See Also:



35
36
37
 
# File 'transfer/cfn_profile_props.rb', line 35

def profile_type
  @profile_type
end

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

Key-value pairs that can be used to group and search for profiles.

Returns:

See Also:



47
48
49
 
# File 'transfer/cfn_profile_props.rb', line 47

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'transfer/cfn_profile_props.rb', line 49

def self.jsii_properties
  {
    :as2_id => "as2Id",
    :profile_type => "profileType",
    :certificate_ids => "certificateIds",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'transfer/cfn_profile_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "as2Id" => @as2_id,
    "profileType" => @profile_type,
    "certificateIds" => @certificate_ids,
    "tags" => @tags,
  })
  result.compact
end