Class CfnSite
A CloudFormation AWS::NetworkManager::Site
.
Inherited Members
Namespace: Amazon.CDK.AWS.NetworkManager
Assembly: Amazon.CDK.AWS.NetworkManager.dll
Syntax (csharp)
public class CfnSite : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSite
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a new site in a global network.
CloudformationResource: AWS::NetworkManager::Site
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NetworkManager;
var cfnSite = new CfnSite(this, "MyCfnSite", new CfnSiteProps {
GlobalNetworkId = "globalNetworkId",
// the properties below are optional
Description = "description",
Location = new LocationProperty {
Address = "address",
Latitude = "latitude",
Longitude = "longitude"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSite(Construct, String, ICfnSiteProps) | Create a new |
CfnSite(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSite(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrSiteArn | The ARN of the site. |
AttrSiteId | The ID of the site. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of your site. |
GlobalNetworkId | The ID of the global network. |
Location | The site location. |
Tags | The tags for the site. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSite(Construct, String, ICfnSiteProps)
Create a new AWS::NetworkManager::Site
.
public CfnSite(Construct scope, string id, ICfnSiteProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSiteProps
- resource properties.
CfnSite(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSite(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSite(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSite(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrSiteArn
The ARN of the site.
public virtual string AttrSiteArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223
.
CloudformationAttribute: SiteArn
AttrSiteId
The ID of the site.
public virtual string AttrSiteId { get; }
Property Value
System.String
Remarks
For example, site-444555aaabbb11223
.
CloudformationAttribute: SiteId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of your site.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Constraints: Maximum length of 256 characters.
GlobalNetworkId
The ID of the global network.
public virtual string GlobalNetworkId { get; set; }
Property Value
System.String
Remarks
Location
The site location.
public virtual object Location { get; set; }
Property Value
System.Object
Remarks
This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.
Tags
The tags for the site.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>