Package software.amazon.awscdk.services.apigateway

Interface IDomainName.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IDomainName, IDomainNameRef, IDomainNameRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IDomainName.Jsii$Proxy
Enclosing interface:
IDomainName
@Internal public static interface IDomainName.Jsii$Default extends IDomainName, IResource.Jsii$Default, IDomainNameRef.Jsii$Default
Internal default implementation for IDomainName.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IDomainName
      Specified by:
      getNode in interface IDomainNameRef.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getDomainNameRef

      @Stability(Experimental) @NotNull default DomainNameReference getDomainNameRef()
      (experimental) A reference to a DomainName resource.
      Specified by:
      getDomainNameRef in interface IDomainNameRef
      Specified by:
      getDomainNameRef in interface IDomainNameRef.Jsii$Default

    • getDomainName

      @Stability(Stable) @NotNull default String getDomainName()
      The domain name (e.g. example.com).
      Specified by:
      getDomainName in interface IDomainName

    • getDomainNameAliasDomainName

      @Stability(Stable) @NotNull default String getDomainNameAliasDomainName()
      The Route53 alias target to use in order to connect a record set to this domain through an alias.
      Specified by:
      getDomainNameAliasDomainName in interface IDomainName

    • getDomainNameAliasHostedZoneId

      @Stability(Stable) @NotNull default String getDomainNameAliasHostedZoneId()
      The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
      Specified by:
      getDomainNameAliasHostedZoneId in interface IDomainName

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.