software.amazon.awscdk.services.networkmanager

Interface CfnSiteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSiteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.064Z")
 @Stability(value=Stable)
public interface CfnSiteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnSite`.

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.*;
 CfnSiteProps cfnSiteProps = CfnSiteProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSiteProps.Builder A builder for CfnSiteProps
static class	CfnSiteProps.Jsii$Proxy An implementation for CfnSiteProps

Method Summary

Modifier and Type	Method and Description
static CfnSiteProps.Builder	builder()
default String	getDescription() A description of your site.
String	getGlobalNetworkId() The ID of the global network.
default Object	getLocation() The site location.
default List<CfnTag>	getTags() The tags for the site.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGlobalNetworkId

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

The ID of the global network.

getDescription

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

A description of your site.

Constraints: Maximum length of 256 characters.

getLocation

@Stability(value=Stable)
 @Nullable
default 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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The tags for the site.

builder

@Stability(value=Stable)
static CfnSiteProps.Builder builder()

Returns:

a CfnSiteProps.Builder of CfnSiteProps