software.amazon.awscdk.services.networkmanager

Class CfnCustomerGatewayAssociation

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.networkmanager.CfnCustomerGatewayAssociation

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.565Z")
public class CfnCustomerGatewayAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::CustomerGatewayAssociation`.

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();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomerGatewayAssociation(Construct scope, java.lang.String id, CfnCustomerGatewayAssociationProps props) Create a new `AWS::NetworkManager::CustomerGatewayAssociation`.
protected	CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomerGatewayAssociation

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

CfnCustomerGatewayAssociation

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

CfnCustomerGatewayAssociation

public CfnCustomerGatewayAssociation(Construct scope,
                                     java.lang.String id,
                                     CfnCustomerGatewayAssociationProps props)

Create a new `AWS::NetworkManager::CustomerGatewayAssociation`.

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCustomerGatewayArn

public java.lang.String getCustomerGatewayArn()

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

setCustomerGatewayArn

public void setCustomerGatewayArn(java.lang.String value)

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

getDeviceId

public java.lang.String getDeviceId()

The ID of the device.

setDeviceId

public void setDeviceId(java.lang.String value)

The ID of the device.

getGlobalNetworkId

public java.lang.String getGlobalNetworkId()

The ID of the global network.

setGlobalNetworkId

public void setGlobalNetworkId(java.lang.String value)

The ID of the global network.

getLinkId

public java.lang.String getLinkId()

The ID of the link.

setLinkId

public void setLinkId(java.lang.String value)

The ID of the link.