Package software.amazon.awscdk.services.ec2

Class CfnLocalGatewayRoute

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.CfnLocalGatewayRoute

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.569Z")
@Stability(Stable)
public class CfnLocalGatewayRoute
extends CfnResource
implements IInspectable

Creates a static route for the specified local gateway route table. You must specify one of the following targets:.

• LocalGatewayVirtualInterfaceGroupId
• NetworkInterfaceId

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.*;
 CfnLocalGatewayRoute cfnLocalGatewayRoute = CfnLocalGatewayRoute.Builder.create(this, "MyCfnLocalGatewayRoute")
         .destinationCidrBlock("destinationCidrBlock")
         .localGatewayRouteTableId("localGatewayRouteTableId")
         // the properties below are optional
         .localGatewayVirtualInterfaceGroupId("localGatewayVirtualInterfaceGroupId")
         .networkInterfaceId("networkInterfaceId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-localgatewayroute.html

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnLocalGatewayRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocalGatewayRoute(software.amazon.jsii.JsiiObjectRef objRef)
	CfnLocalGatewayRoute(software.constructs.Construct scope, String id, CfnLocalGatewayRouteProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrState()	The state of the local gateway route table.
String	getAttrType()	The type of local gateway route.
protected Map<String,Object>	getCfnProperties()
String	getDestinationCidrBlock()	The CIDR block used for destination matches.
String	getLocalGatewayRouteTableId()	The ID of the local gateway route table.
String	getLocalGatewayVirtualInterfaceGroupId()	The ID of the virtual interface group.
String	getNetworkInterfaceId()	The ID of the network interface.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestinationCidrBlock(String value)	The CIDR block used for destination matches.
void	setLocalGatewayRouteTableId(String value)	The ID of the local gateway route table.
void	setLocalGatewayVirtualInterfaceGroupId(String value)	The ID of the virtual interface group.
void	setNetworkInterfaceId(String value)	The ID of the network interface.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnLocalGatewayRoute

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

CfnLocalGatewayRoute

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

CfnLocalGatewayRoute

@Stability(Stable)
public CfnLocalGatewayRoute(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnLocalGatewayRouteProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The state of the local gateway route table.

getAttrType

@Stability(Stable)
@NotNull
public String getAttrType()

The type of local gateway route.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDestinationCidrBlock

@Stability(Stable)
@NotNull
public String getDestinationCidrBlock()

The CIDR block used for destination matches.

setDestinationCidrBlock

@Stability(Stable)
public void setDestinationCidrBlock(@NotNull
 String value)

The CIDR block used for destination matches.

getLocalGatewayRouteTableId

@Stability(Stable)
@NotNull
public String getLocalGatewayRouteTableId()

The ID of the local gateway route table.

setLocalGatewayRouteTableId

@Stability(Stable)
public void setLocalGatewayRouteTableId(@NotNull
 String value)

The ID of the local gateway route table.

getLocalGatewayVirtualInterfaceGroupId

@Stability(Stable)
@Nullable
public String getLocalGatewayVirtualInterfaceGroupId()

The ID of the virtual interface group.

setLocalGatewayVirtualInterfaceGroupId

@Stability(Stable)
public void setLocalGatewayVirtualInterfaceGroupId(@Nullable
 String value)

The ID of the virtual interface group.

getNetworkInterfaceId

@Stability(Stable)
@Nullable
public String getNetworkInterfaceId()

The ID of the network interface.

setNetworkInterfaceId

@Stability(Stable)
public void setNetworkInterfaceId(@Nullable
 String value)

The ID of the network interface.