software.amazon.awscdk.services.networkmanager

Class CfnLink

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.935Z")
public class CfnLink
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::Link`.

Specifies a link for a site.

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.*;
 CfnLink cfnLink = CfnLink.Builder.create(this, "MyCfnLink")
         .bandwidth(BandwidthProperty.builder()
                 .downloadSpeed(123)
                 .uploadSpeed(123)
                 .build())
         .globalNetworkId("globalNetworkId")
         .siteId("siteId")
         // the properties below are optional
         .description("description")
         .provider("provider")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnLink.BandwidthProperty Describes bandwidth information.
static class	CfnLink.Builder A fluent builder for CfnLink.

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
	CfnLink(Construct scope, java.lang.String id, CfnLinkProps props) Create a new `AWS::NetworkManager::Link`.
protected	CfnLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLink(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrLinkArn() The ARN of the link.
java.lang.String	getAttrLinkId() The ID of the link.
java.lang.Object	getBandwidth() The bandwidth for the link.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the link.
java.lang.String	getGlobalNetworkId() The ID of the global network.
java.lang.String	getProvider() The provider of the link.
java.lang.String	getSiteId() The ID of the site.
TagManager	getTags() The tags for the link.
java.lang.String	getType() The type 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	setBandwidth(CfnLink.BandwidthProperty value) The bandwidth for the link.
void	setBandwidth(IResolvable value) The bandwidth for the link.
void	setDescription(java.lang.String value) A description of the link.
void	setGlobalNetworkId(java.lang.String value) The ID of the global network.
void	setProvider(java.lang.String value) The provider of the link.
void	setSiteId(java.lang.String value) The ID of the site.
void	setType(java.lang.String value) The type 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

CfnLink

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

CfnLink

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

CfnLink

public CfnLink(Construct scope,
               java.lang.String id,
               CfnLinkProps props)

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

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.

getAttrLinkArn

public java.lang.String getAttrLinkArn()

The ARN of the link.

For example, arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1 .

getAttrLinkId

public java.lang.String getAttrLinkId()

The ID of the link.

For example, link-11112222aaaabbbb1 .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags for the link.

getBandwidth

public java.lang.Object getBandwidth()

The bandwidth for the link.

setBandwidth

public void setBandwidth(IResolvable value)

The bandwidth for the link.

setBandwidth

public void setBandwidth(CfnLink.BandwidthProperty value)

The bandwidth for the link.

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.

getSiteId

public java.lang.String getSiteId()

The ID of the site.

setSiteId

public void setSiteId(java.lang.String value)

The ID of the site.

getDescription

public java.lang.String getDescription()

A description of the link.

Constraints: Maximum length of 256 characters.

setDescription

public void setDescription(java.lang.String value)

A description of the link.

Constraints: Maximum length of 256 characters.

getProvider

public java.lang.String getProvider()

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

setProvider

public void setProvider(java.lang.String value)

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

getType

public java.lang.String getType()

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

setType

public void setType(java.lang.String value)

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^