software.amazon.awscdk.services.networkmanager

Class CfnLink

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

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:41.061Z")
 @Stability(value=Stable)
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 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
	CfnLink(software.constructs.Construct scope, 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
String	getAttrLinkArn() The ARN of the link.
String	getAttrLinkId() The ID of the link.
Object	getBandwidth() The bandwidth for the link.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the link.
String	getGlobalNetworkId() The ID of the global network.
String	getProvider() The provider of the link.
String	getSiteId() The ID of the site.
TagManager	getTags() The tags for the link.
String	getType() The type of the link.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBandwidth(CfnLink.BandwidthProperty value) The bandwidth for the link.
void	setBandwidth(IResolvable value) The bandwidth for the link.
void	setDescription(String value) A description of the link.
void	setGlobalNetworkId(String value) The ID of the global network.
void	setProvider(String value) The provider of the link.
void	setSiteId(String value) The ID of the site.
void	setType(String value) The type of the link.

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

CfnLink

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

CfnLink

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

CfnLink

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

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

getAttrLinkArn

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

The ARN of the link.

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

getAttrLinkId

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

The ID of the link.

For example, link-11112222aaaabbbb1 .

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the link.

getBandwidth

@Stability(value=Stable)
 @NotNull
public Object getBandwidth()

The bandwidth for the link.

setBandwidth

@Stability(value=Stable)
public void setBandwidth(@NotNull
                                                  CfnLink.BandwidthProperty value)

The bandwidth for the link.

setBandwidth

@Stability(value=Stable)
public void setBandwidth(@NotNull
                                                  IResolvable value)

The bandwidth for the link.

getGlobalNetworkId

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

The ID of the global network.

setGlobalNetworkId

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

The ID of the global network.

getSiteId

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

The ID of the site.

setSiteId

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

The ID of the site.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the link.

Constraints: Maximum length of 256 characters.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the link.

Constraints: Maximum length of 256 characters.

getProvider

@Stability(value=Stable)
 @Nullable
public String getProvider()

The provider of the link.

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

setProvider

@Stability(value=Stable)
public void setProvider(@Nullable
                                                 String value)

The provider of the link.

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

getType

@Stability(value=Stable)
 @Nullable
public String getType()

The type of the link.

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

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

The type of the link.

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