Class CfnSite

Creates a new site in a global network.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSite

Implements

IInspectable

ISiteRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.NetworkManager

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSite : CfnResource, IInspectable, ISiteRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnSite Inherits CfnResource Implements IInspectable, ISiteRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

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 AWS::NetworkManager::Site.

Properties

AttrCreatedAt	The time that the site was created.
AttrSiteArn	The ARN of the site.
AttrSiteId	The ID of the site.
AttrState	The current state of the site.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a new site in a global network.
Description	A description of your site.
GlobalNetworkId	The ID of the global network.
Location	The site location.
SiteRef	A reference to a Site resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags for the site.

Methods

ArnForSite(ISiteRef)	Creates a new site in a global network.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSite(object)	Checks whether the given object is a CfnSite.
RenderProperties(IDictionary<string, object>)	Creates a new site in a global network.

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 string: Construct identifier for this resource (unique in its scope).
props ICfnSiteProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

The time that the site was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrSiteArn

The ARN of the site.

public virtual string AttrSiteArn { get; }

Property Value

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

string

Remarks

For example, site-444555aaabbb11223 .

CloudformationAttribute: SiteId

AttrState

The current state of the site.

public virtual string AttrState { get; }

Property Value

string

Remarks

CloudformationAttribute: State

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new site in a global network.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

Description

A description of your site.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

GlobalNetworkId

The ID of the global network.

public virtual string GlobalNetworkId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

Location

The site location.

public virtual object? Location { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnSite.ILocationProperty

SiteRef

A reference to a Site resource.

public virtual ISiteReference SiteRef { get; }

Property Value

ISiteReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

TagsRaw

The tags for the site.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

Methods

ArnForSite(ISiteRef)

Creates a new site in a global network.

public static string ArnForSite(ISiteRef resource)

Parameters

resource ISiteRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

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"
                 } }
             });

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

IsCfnSite(object)

Checks whether the given object is a CfnSite.

public static bool IsCfnSite(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new site in a global network.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-site.html

CloudformationResource: AWS::NetworkManager::Site

ExampleMetadata: fixture=_generated

Implements

IInspectable

ISiteRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable