software.amazon.awscdk.services.ec2

Class CfnVPNGatewayRoutePropagation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnVPNGatewayRoutePropagation

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.384Z")
 @Stability(value=Stable)
public class CfnVPNGatewayRoutePropagation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::VPNGatewayRoutePropagation`.

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The AWS::EC2::VPNGatewayRoutePropagation resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a DependsOn Attribute in the AWS::EC2::VPNGatewayRoutePropagation resource to explicitly declare a dependency on the VPN gateway attachment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnVPNGatewayRoutePropagation cfnVPNGatewayRoutePropagation = CfnVPNGatewayRoutePropagation.Builder.create(this, "MyCfnVPNGatewayRoutePropagation")
         .routeTableIds(List.of("routeTableIds"))
         .vpnGatewayId("vpnGatewayId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVPNGatewayRoutePropagation.Builder A fluent builder for CfnVPNGatewayRoutePropagation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVPNGatewayRoutePropagation(software.constructs.Construct scope, String id, CfnVPNGatewayRoutePropagationProps props) Create a new `AWS::EC2::VPNGatewayRoutePropagation`.
protected	CfnVPNGatewayRoutePropagation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPNGatewayRoutePropagation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID of the VPN gateway.
protected Map<String,Object>	getCfnProperties()
List<String>	getRouteTableIds() The ID of the route table.
String	getVpnGatewayId() The ID of the virtual private gateway that is attached to a VPC.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRouteTableIds(List<String> value) The ID of the route table.
void	setVpnGatewayId(String value) The ID of the virtual private gateway that is attached to a VPC.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPNGatewayRoutePropagation

protected CfnVPNGatewayRoutePropagation(software.amazon.jsii.JsiiObjectRef objRef)

CfnVPNGatewayRoutePropagation

protected CfnVPNGatewayRoutePropagation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVPNGatewayRoutePropagation

@Stability(value=Stable)
public CfnVPNGatewayRoutePropagation(@NotNull
                                                              software.constructs.Construct scope,
                                                              @NotNull
                                                              String id,
                                                              @NotNull
                                                              CfnVPNGatewayRoutePropagationProps props)

Create a new `AWS::EC2::VPNGatewayRoutePropagation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the VPN gateway.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRouteTableIds

@Stability(value=Stable)
 @NotNull
public List<String> getRouteTableIds()

The ID of the route table.

The routing table must be associated with the same VPC that the virtual private gateway is attached to.

setRouteTableIds

@Stability(value=Stable)
public void setRouteTableIds(@NotNull
                                                      List<String> value)

The ID of the route table.

The routing table must be associated with the same VPC that the virtual private gateway is attached to.

getVpnGatewayId

@Stability(value=Stable)
 @NotNull
public String getVpnGatewayId()

The ID of the virtual private gateway that is attached to a VPC.

The virtual private gateway must be attached to the same VPC that the routing tables are associated with.

setVpnGatewayId

@Stability(value=Stable)
public void setVpnGatewayId(@NotNull
                                                     String value)

The ID of the virtual private gateway that is attached to a VPC.

The virtual private gateway must be attached to the same VPC that the routing tables are associated with.