Show / Hide Table of Contents

Class CfnLink

Specifies a link for a site.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnLink
Implements
IInspectable
ILinkRef
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.AddResourceDependency(CfnResource, string)
CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.RemoveResourceDependency(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 CfnLink : CfnResource, IInspectable, ILinkRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnLink Inherits CfnResource Implements IInspectable, ILinkRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

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

CloudformationResource: AWS::NetworkManager::Link

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 cfnLink = new CfnLink(this, "MyCfnLink", new CfnLinkProps {
                 Bandwidth = new BandwidthProperty {
                     DownloadSpeed = 123,
                     UploadSpeed = 123
                 },
                 GlobalNetworkId = "globalNetworkId",
                 SiteId = "siteId",

                 // the properties below are optional
                 Description = "description",
                 Provider = "provider",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             });

Synopsis

Constructors

CfnLink(Construct, string, ICfnLinkProps)

Create a new AWS::NetworkManager::Link.

Properties

AttrCreatedAt

The date and time that the link was created.

AttrLinkArn

The ARN of the link.

AttrLinkId

The ID of the link.

AttrState

The state of the link.

Bandwidth

The bandwidth for the link.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Specifies a link for a site.

CfnPropertyNames

Specifies a link for a site.

Description

A description of the link.

GlobalNetworkId

The ID of the global network.

LinkRef

A reference to a Link resource.

Provider

The provider of the link.

SiteId

The ID of the site.

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

The tags for the link.

Type

The type of the link.

Methods

ArnForLink(ILinkRef)

Specifies a link for a site.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnLink(object)

Checks whether the given object is a CfnLink.

RenderProperties(IDictionary<string, object>)

Specifies a link for a site.

Constructors

CfnLink(Construct, string, ICfnLinkProps)

Create a new AWS::NetworkManager::Link.

public CfnLink(Construct scope, string id, ICfnLinkProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnLinkProps

Resource properties.

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

The date and time that the link was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrLinkArn

The ARN of the link.

public virtual string AttrLinkArn { get; }
Property Value

string

Remarks

For example, arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1 .

CloudformationAttribute: LinkArn

AttrLinkId

The ID of the link.

public virtual string AttrLinkId { get; }
Property Value

string

Remarks

For example, link-11112222aaaabbbb1 .

CloudformationAttribute: LinkId

AttrState

The state of the link.

public virtual string AttrState { get; }
Property Value

string

Remarks

CloudformationAttribute: State

Bandwidth

The bandwidth for the link.

public virtual object Bandwidth { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnLink.IBandwidthProperty

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-link.html

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a link for a site.

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

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

CfnPropertyNames

Specifies a link for a site.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Description

A description of the link.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

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-link.html

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

LinkRef

A reference to a Link resource.

public virtual ILinkReference LinkRef { get; }
Property Value

ILinkReference

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Provider

The provider of the link.

public virtual string? Provider { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

SiteId

The ID of the site.

public virtual string SiteId { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

TagsRaw

The tags for the link.

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

ICfnTag[]

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Type

The type of the link.

public virtual string? Type { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Methods

ArnForLink(ILinkRef)

Specifies a link for a site.

public static string ArnForLink(ILinkRef resource)
Parameters
resource ILinkRef
Returns

string

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

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 cfnLink = new CfnLink(this, "MyCfnLink", new CfnLinkProps {
                 Bandwidth = new BandwidthProperty {
                     DownloadSpeed = 123,
                     UploadSpeed = 123
                 },
                 GlobalNetworkId = "globalNetworkId",
                 SiteId = "siteId",

                 // the properties below are optional
                 Description = "description",
                 Provider = "provider",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             });

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-link.html

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

IsCfnLink(object)

Checks whether the given object is a CfnLink.

public static bool IsCfnLink(object x)
Parameters
x object
Returns

bool

Remarks

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

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a link for a site.

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-link.html

CloudformationResource: AWS::NetworkManager::Link

ExampleMetadata: fixture=_generated

Implements

IInspectable
ILinkRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggable
Back to top Generated by DocFX