Package software.amazon.awscdk.services.networkmanager

Class CfnSite

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.CfnSite
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.478Z") @Stability(Stable) public class CfnSite extends CfnResource implements IInspectable
A CloudFormation AWS::NetworkManager::Site.

Creates a new site in a global network.

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.*;
 CfnSite cfnSite = CfnSite.Builder.create(this, "MyCfnSite")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .description("description")
         .location(LocationProperty.builder()
                 .address("address")
                 .latitude("latitude")
                 .longitude("longitude")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnSite

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

    • CfnSite

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

    • CfnSite

      @Stability(Stable) public CfnSite(@NotNull Construct scope, @NotNull String id, @NotNull CfnSiteProps props)
      Create a new AWS::NetworkManager::Site.

      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.

    • getAttrSiteArn

      @Stability(Stable) @NotNull public String getAttrSiteArn()
      The ARN of the site.

      For example, arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223 .

    • getAttrSiteId

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

      For example, site-444555aaabbb11223 .

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

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

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of your site.

      Constraints: Maximum length of 256 characters.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of your site.

      Constraints: Maximum length of 256 characters.

    • getLocation

      @Stability(Stable) @Nullable public Object getLocation()
      The site location.

      This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

      • Address : The physical address of the site.
      • Latitude : The latitude of the site.
      • Longitude : The longitude of the site.

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable IResolvable value)
      The site location.

      This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

      • Address : The physical address of the site.
      • Latitude : The latitude of the site.
      • Longitude : The longitude of the site.

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable CfnSite.LocationProperty value)
      The site location.

      This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

      • Address : The physical address of the site.
      • Latitude : The latitude of the site.
      • Longitude : The longitude of the site.