Package software.amazon.awscdk.services.networkmanager

Class CfnLink

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.460Z") @Stability(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();

  • 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

    • CfnLink

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

    • CfnLink

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

    • CfnLink

      @Stability(Stable) public CfnLink(@NotNull 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 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.

    • getAttrLinkArn

      @Stability(Stable) @NotNull public String getAttrLinkArn()
      The ARN of the link.

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

    • getAttrLinkId

      @Stability(Stable) @NotNull public String getAttrLinkId()
      The ID of the link.

      For example, link-11112222aaaabbbb1 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags for the link.

    • getBandwidth

      @Stability(Stable) @NotNull public Object getBandwidth()
      The bandwidth for the link.

    • setBandwidth

      @Stability(Stable) public void setBandwidth(@NotNull IResolvable value)
      The bandwidth for the link.

    • setBandwidth

      @Stability(Stable) public void setBandwidth(@NotNull CfnLink.BandwidthProperty value)
      The bandwidth for the link.

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

    • getSiteId

      @Stability(Stable) @NotNull public String getSiteId()
      The ID of the site.

    • setSiteId

      @Stability(Stable) public void setSiteId(@NotNull String value)
      The ID of the site.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the link.

      Constraints: Maximum length of 256 characters.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the link.

      Constraints: Maximum length of 256 characters.

    • getProvider

      @Stability(Stable) @Nullable public String getProvider()
      The provider of the link.

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

    • setProvider

      @Stability(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(Stable) @Nullable public String getType()
      The type of the link.

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

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The type of the link.

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