software.amazon.awscdk.services.networkmanager

Class CfnSite

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

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.063Z")
 @Stability(value=Stable)
public class CfnSite
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkManager::Site`.

Specifies a 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSite.Builder A fluent builder for CfnSite.
static interface	CfnSite.LocationProperty Describes a location.

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
	CfnSite(software.constructs.Construct scope, String id, CfnSiteProps props) Create a new `AWS::NetworkManager::Site`.
protected	CfnSite(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSite(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrSiteArn() The ARN of the site.
String	getAttrSiteId() The ID of the site.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of your site.
String	getGlobalNetworkId() The ID of the global network.
Object	getLocation() The site location.
TagManager	getTags() The tags for the site.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of your site.
void	setGlobalNetworkId(String value) The ID of the global network.
void	setLocation(CfnSite.LocationProperty value) The site location.
void	setLocation(IResolvable value) The site location.

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

CfnSite

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

CfnSite

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

CfnSite

@Stability(value=Stable)
public CfnSite(@NotNull
                                        software.constructs.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 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.

getAttrSiteArn

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

The ARN of the site.

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

getAttrSiteId

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

The ID of the site.

For example, site-444555aaabbb11223 .

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

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.

getDescription

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

A description of your site.

Constraints: Maximum length of 256 characters.

setDescription

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

A description of your site.

Constraints: Maximum length of 256 characters.

getLocation

@Stability(value=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(value=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.

setLocation

@Stability(value=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.