Class CfnDomain

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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

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

CloudformationResource: AWS::Amplify::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.Amplify;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 AppId = "appId",
                 DomainName = "domainName",
                 SubDomainSettings = new [] { new SubDomainSettingProperty {
                     BranchName = "branchName",
                     Prefix = "prefix"
                 } },

                 // the properties below are optional
                 AutoSubDomainCreationPatterns = new [] { "autoSubDomainCreationPatterns" },
                 AutoSubDomainIamRole = "autoSubDomainIamRole",
                 CertificateSettings = new CertificateSettingsProperty {
                     CertificateType = "certificateType",
                     CustomCertificateArn = "customCertificateArn"
                 },
                 EnableAutoSubDomain = false
             });

Synopsis

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::Amplify::Domain.

Properties

AppId

The unique ID for an Amplify app.
AttrArn

ARN for the Domain Association.
AttrAutoSubDomainCreationPatterns

Branch patterns for the automatically created subdomain.
AttrAutoSubDomainIamRole

The IAM service role for the subdomain.
AttrCertificate

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.
AttrCertificateRecord

DNS Record for certificate verification.
AttrDomainName

Name of the domain.
AttrDomainStatus

Status for the Domain Association.
AttrEnableAutoSubDomain

Specifies whether the automated creation of subdomains for branches is enabled.
AttrStatusReason

Reason for the current status of the domain.
AttrUpdateStatus

The status of the domain update operation that is currently in progress.
AutoSubDomainCreationPatterns

Sets the branch patterns for automatic subdomain creation.
AutoSubDomainIamRole

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CertificateSettings

The type of SSL/TLS certificate to use for your custom domain.
CfnProperties

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.
CfnPropertyNames

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.
DomainName

The domain name for the domain association.
DomainRef

A reference to a Domain resource.
EnableAutoSubDomain

Enables the automated creation of subdomains for branches.
SubDomainSettings

The setting for the subdomain.

Methods

ArnForDomain(IDomainRef)

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.
Inspect(TreeInspector)

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

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

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

Constructors

CfnDomain(Construct, string, ICfnDomainProps)

Create a new AWS::Amplify::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-amplify-domain.html

CloudformationResource: AWS::Amplify::Domain

ExampleMetadata: fixture=_generated

Properties

AppId

The unique ID for an Amplify app.

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

string

Remarks

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

CloudformationResource: AWS::Amplify::Domain

ExampleMetadata: fixture=_generated

AttrArn

ARN for the Domain Association.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrAutoSubDomainCreationPatterns

Branch patterns for the automatically created subdomain.

public virtual string[] AttrAutoSubDomainCreationPatterns { get; }
Property Value

string[]

Remarks

CloudformationAttribute: AutoSubDomainCreationPatterns

AttrAutoSubDomainIamRole

The IAM service role for the subdomain.

public virtual string AttrAutoSubDomainIamRole { get; }
Property Value

string

Remarks

CloudformationAttribute: AutoSubDomainIAMRole

AttrCertificate

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

public virtual IResolvable AttrCertificate { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Certificate

AttrCertificateRecord

DNS Record for certificate verification.

public virtual string AttrCertificateRecord { get; }
Property Value

string

Remarks

CloudformationAttribute: CertificateRecord

AttrDomainName

Name of the domain.

public virtual string AttrDomainName { get; }
Property Value

string

Remarks

CloudformationAttribute: DomainName

AttrDomainStatus

Status for the Domain Association.

public virtual string AttrDomainStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: DomainStatus

AttrEnableAutoSubDomain

Specifies whether the automated creation of subdomains for branches is enabled.

public virtual IResolvable AttrEnableAutoSubDomain { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: EnableAutoSubDomain

AttrStatusReason

Reason for the current status of the domain.

public virtual string AttrStatusReason { get; }
Property Value

string

Remarks

CloudformationAttribute: StatusReason

AttrUpdateStatus

The status of the domain update operation that is currently in progress.

public virtual string AttrUpdateStatus { get; }
Property Value

string

Remarks

The following list describes the valid update states.

    CloudformationAttribute: UpdateStatus

    AutoSubDomainCreationPatterns

    Sets the branch patterns for automatic subdomain creation.

    public virtual string[]? AutoSubDomainCreationPatterns { get; set; }
    Property Value

    string[]

    Remarks

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    AutoSubDomainIamRole

    The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

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

    string

    Remarks

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    CertificateSettings

    The type of SSL/TLS certificate to use for your custom domain.

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

    object

    Remarks

    Type union: either IResolvable or CfnDomain.ICertificateSettingsProperty

    CfnProperties

    Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    CfnPropertyNames

    Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    DomainName

    The domain name for the domain association.

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

    string

    Remarks

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

    CloudformationResource: AWS::Amplify::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-amplify-domain.html

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    EnableAutoSubDomain

    Enables the automated creation of subdomains for branches.

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

    object

    Remarks

    Type union: either bool or IResolvable

    SubDomainSettings

    The setting for the subdomain.

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

    object

    Remarks

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

    Methods

    ArnForDomain(IDomainRef)

    Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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

    string

    Remarks

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

    CloudformationResource: AWS::Amplify::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.Amplify;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 AppId = "appId",
                 DomainName = "domainName",
                 SubDomainSettings = new [] { new SubDomainSettingProperty {
                     BranchName = "branchName",
                     Prefix = "prefix"
                 } },

                 // the properties below are optional
                 AutoSubDomainCreationPatterns = new [] { "autoSubDomainCreationPatterns" },
                 AutoSubDomainIamRole = "autoSubDomainIamRole",
                 CertificateSettings = new CertificateSettingsProperty {
                     CertificateType = "certificateType",
                     CustomCertificateArn = "customCertificateArn"
                 },
                 EnableAutoSubDomain = false
             });

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

    CloudformationResource: AWS::Amplify::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-amplify-domain.html

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    RenderProperties(IDictionary<string, object>)

    Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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

    CloudformationResource: AWS::Amplify::Domain

    ExampleMetadata: fixture=_generated

    Implements

    Constructs.IConstruct
    Constructs.IDependable