Class: AWSCDK::EC2::CfnVPCPeeringConnectionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_vpc_peering_connection_props.rb

Overview

Properties for defining a CfnVPCPeeringConnection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(peer_vpc_id:, vpc_id:, assume_role_region: nil, peer_owner_id: nil, peer_region: nil, peer_role_arn: nil, tags: nil) ⇒ CfnVPCPeeringConnectionProps

Returns a new instance of CfnVPCPeeringConnectionProps.

Parameters:

  • peer_vpc_id (String, AWSCDK::Interfaces::AWSEC2::IVPCRef) —

    The ID of the VPC with which you are creating the VPC peering connection.

  • vpc_id (String, AWSCDK::Interfaces::AWSEC2::IVPCRef) —

    The ID of the VPC.

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

    The Region code to use when calling Security Token Service (STS) to assume the PeerRoleArn, if provided.

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

    The AWS account ID of the owner of the accepter VPC.

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

    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

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

    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.

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

    Any tags assigned to the resource.



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

def initialize(peer_vpc_id:, vpc_id:, assume_role_region: nil, peer_owner_id: nil, peer_region: nil, peer_role_arn: nil, tags: nil)
  @peer_vpc_id = peer_vpc_id
  Jsii::Type.check_type(@peer_vpc_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVZQQ1JlZiJ9XX19")), "peerVpcId")
  @vpc_id = vpc_id
  Jsii::Type.check_type(@vpc_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVZQQ1JlZiJ9XX19")), "vpcId")
  @assume_role_region = assume_role_region
  Jsii::Type.check_type(@assume_role_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assumeRoleRegion") unless @assume_role_region.nil?
  @peer_owner_id = peer_owner_id
  Jsii::Type.check_type(@peer_owner_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerOwnerId") unless @peer_owner_id.nil?
  @peer_region = peer_region
  Jsii::Type.check_type(@peer_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerRegion") unless @peer_region.nil?
  @peer_role_arn = peer_role_arn
  Jsii::Type.check_type(@peer_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peerRoleArn") unless @peer_role_arn.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

#assume_role_region ⇒ String? (readonly)

The Region code to use when calling Security Token Service (STS) to assume the PeerRoleArn, if provided.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 49

def assume_role_region
  @assume_role_region
end

#peer_owner_id ⇒ String? (readonly)

The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 56

def peer_owner_id
  @peer_owner_id
end

#peer_region ⇒ String? (readonly)

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 63

def peer_region
  @peer_region
end

#peer_role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.

This is required when you are peering a VPC in a different AWS account.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 70

def peer_role_arn
  @peer_role_arn
end

#peer_vpc_id ⇒ String, AWSCDK::Interfaces::AWSEC2::IVPCRef (readonly)

The ID of the VPC with which you are creating the VPC peering connection.

You must specify this parameter in the request.

Returns:

See Also:



39
40
41
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 39

def peer_vpc_id
  @peer_vpc_id
end

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

Any tags assigned to the resource.

Returns:

See Also:



75
76
77
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 75

def tags
  @tags
end

#vpc_id ⇒ String, AWSCDK::Interfaces::AWSEC2::IVPCRef (readonly)

The ID of the VPC.

Returns:

See Also:



44
45
46
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 44

def vpc_id
  @vpc_id
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 77

def self.jsii_properties
  {
    :peer_vpc_id => "peerVpcId",
    :vpc_id => "vpcId",
    :assume_role_region => "assumeRoleRegion",
    :peer_owner_id => "peerOwnerId",
    :peer_region => "peerRegion",
    :peer_role_arn => "peerRoleArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'ec2/cfn_vpc_peering_connection_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "peerVpcId" => @peer_vpc_id,
    "vpcId" => @vpc_id,
    "assumeRoleRegion" => @assume_role_region,
    "peerOwnerId" => @peer_owner_id,
    "peerRegion" => @peer_region,
    "peerRoleArn" => @peer_role_arn,
    "tags" => @tags,
  })
  result.compact
end