Class: AWSCDK::NetworkManager::CfnCoreNetworkProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
network_manager/cfn_core_network_props.rb

Overview

Properties for defining a CfnCoreNetwork.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(global_network_id:, description: nil, policy_document: nil, tags: nil) ⇒ CfnCoreNetworkProps

Returns a new instance of CfnCoreNetworkProps.

Parameters:

  • global_network_id (String) —

    The ID of the global network that your core network is a part of.

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

    The description of a core network.

  • policy_document (Object, nil) (defaults to: nil) —

    Describes a core network policy. For more information, see Core network policies .

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

    The list of key-value tags associated with a core network.



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

def initialize(global_network_id:, description: nil, policy_document: nil, tags: nil)
  @global_network_id = global_network_id
  Jsii::Type.check_type(@global_network_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalNetworkId")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @policy_document = policy_document
  Jsii::Type.check_type(@policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "policyDocument") unless @policy_document.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

#description ⇒ String? (readonly)

The description of a core network.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'network_manager/cfn_core_network_props.rb', line 33

def description
  @description
end

#global_network_id ⇒ String (readonly)

The ID of the global network that your core network is a part of.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'network_manager/cfn_core_network_props.rb', line 28

def global_network_id
  @global_network_id
end

#policy_document ⇒ Object? (readonly)

Describes a core network policy. For more information, see Core network policies .

If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy.

Returns:

  • (Object, nil)

See Also:



40
41
42
 
# File 'network_manager/cfn_core_network_props.rb', line 40

def policy_document
  @policy_document
end

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

The list of key-value tags associated with a core network.

Returns:

See Also:



45
46
47
 
# File 'network_manager/cfn_core_network_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'network_manager/cfn_core_network_props.rb', line 47

def self.jsii_properties
  {
    :global_network_id => "globalNetworkId",
    :description => "description",
    :policy_document => "policyDocument",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'network_manager/cfn_core_network_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "globalNetworkId" => @global_network_id,
    "description" => @description,
    "policyDocument" => @policy_document,
    "tags" => @tags,
  })
  result.compact
end