Package software.amazon.awscdk.services.networkmanager

Class CfnCustomerGatewayAssociation

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.networkmanager.CfnCustomerGatewayAssociation

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:04.916Z")
@Stability(Stable)
public class CfnCustomerGatewayAssociation
extends CfnResource
implements IInspectable

Specifies an association between a customer gateway, a device, and optionally, a link.

If you specify a link, it must be associated with the specified device. The customer gateway must be connected to a VPN attachment on a transit gateway that's registered in your global network.

You cannot associate a customer gateway with more than one device and link.

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.networkmanager.*;
 CfnCustomerGatewayAssociation cfnCustomerGatewayAssociation = CfnCustomerGatewayAssociation.Builder.create(this, "MyCfnCustomerGatewayAssociation")
         .customerGatewayArn("customerGatewayArn")
         .deviceId("deviceId")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .linkId("linkId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-customergatewayassociation.html

Nested Class Summary

Nested Classes

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

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	CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCustomerGatewayAssociation(software.constructs.Construct scope, String id, CfnCustomerGatewayAssociationProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getCustomerGatewayArn()	The Amazon Resource Name (ARN) of the customer gateway.
String	getDeviceId()	The ID of the device.
String	getGlobalNetworkId()	The ID of the global network.
String	getLinkId()	The ID of the link.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerGatewayArn(String value)	The Amazon Resource Name (ARN) of the customer gateway.
void	setDeviceId(String value)	The ID of the device.
void	setGlobalNetworkId(String value)	The ID of the global network.
void	setLinkId(String value)	The ID of the link.

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

CfnCustomerGatewayAssociation

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

CfnCustomerGatewayAssociation

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

CfnCustomerGatewayAssociation

@Stability(Stable)
public CfnCustomerGatewayAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCustomerGatewayAssociationProps 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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCustomerGatewayArn

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

The Amazon Resource Name (ARN) of the customer gateway.

setCustomerGatewayArn

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

The Amazon Resource Name (ARN) of the customer gateway.

getDeviceId

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

The ID of the device.

setDeviceId

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

The ID of the device.

getGlobalNetworkId

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

The ID of the global network.

setGlobalNetworkId

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

The ID of the global network.

getLinkId

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

The ID of the link.

setLinkId

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

The ID of the link.