Class CfnDomain

Describes a domain where you are storing recordsets.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDomain
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnDomain Inherits CfnResource Implements IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

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.Lightsail;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 DomainName = "domainName",

                 // the properties below are optional
                 DomainEntries = new [] { new DomainEntryProperty {
                     Name = "name",
                     Target = "target",
                     Type = "type",

                     // the properties below are optional
                     Id = "id",
                     IsAlias = false
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::Lightsail::Domain.

Properties

AttrArn

The Amazon Resource Name (ARN) of the domain recordset ( arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).
AttrCreatedAt

The date when the domain recordset was created.
AttrLocation

The AWS Region and Availability Zone where the domain was created (read-only).
AttrResourceType

The resource type.
AttrSupportCode

The support code.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Describes a domain where you are storing recordsets.
CfnPropertyNames

Describes a domain where you are storing recordsets.
DomainEntries

An array of key-value pairs containing information about the domain entries.
DomainName

The fully qualified domain name in the certificate request.
DomainRef

A reference to a Domain resource.
Tags

The tag keys and optional values for the resource.

Methods

ArnForDomain(IDomainRef)

Describes a domain where you are storing recordsets.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDomain(object)

Checks whether the given object is a CfnDomain.
RenderProperties(IDictionary<string, object>)

Describes a domain where you are storing recordsets.

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::Lightsail::Domain.

public CfnDomain(Construct scope, string id, ICfnDomainProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnDomainProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the domain recordset ( arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedAt

The date when the domain recordset was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrLocation

The AWS Region and Availability Zone where the domain was created (read-only).

public virtual IResolvable AttrLocation { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Location

AttrResourceType

The resource type.

public virtual string AttrResourceType { get; }
Property Value

string

Remarks

CloudformationAttribute: ResourceType

AttrSupportCode

The support code.

public virtual string AttrSupportCode { get; }
Property Value

string

Remarks

Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

CloudformationAttribute: SupportCode

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-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

CfnProperties

Describes a domain where you are storing recordsets.

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

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

CfnPropertyNames

Describes a domain where you are storing recordsets.

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

IDictionary<string, string>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

DomainEntries

An array of key-value pairs containing information about the domain entries.

public virtual object? DomainEntries { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDomain.IDomainEntryProperty)[]

DomainName

The fully qualified domain name in the certificate request.

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

DomainRef

A reference to a Domain resource.

public virtual IDomainReference DomainRef { get; }
Property Value

IDomainReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

Tags

The tag keys and optional values for the resource.

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

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

Methods

ArnForDomain(IDomainRef)

Describes a domain where you are storing recordsets.

public static string ArnForDomain(IDomainRef resource)
Parameters
resource IDomainRef
Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

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.Lightsail;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 DomainName = "domainName",

                 // the properties below are optional
                 DomainEntries = new [] { new DomainEntryProperty {
                     Name = "name",
                     Target = "target",
                     Type = "type",

                     // the properties below are optional
                     Id = "id",
                     IsAlias = false
                 } },
                 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-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

IsCfnDomain(object)

Checks whether the given object is a CfnDomain.

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

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Describes a domain where you are storing recordsets.

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

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-domain.html

CloudformationResource: AWS::Lightsail::Domain

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable