Soft-deprecating IDistribution.domainName

aws · Jul 15, 2020 · fbbda72 · fbbda72
1 parent 4466043
commit fbbda72
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/packages/@aws-cdk/aws-cloudfront/README.md b/packages/@aws-cdk/aws-cloudfront/README.md
@@ -62,10 +62,10 @@ URLs and not S3 URLs directly.
 ### Domain Names and Certificates
 
 When you create a distribution, CloudFront assigns a domain name for the distribution, for example: `d111111abcdef8.cloudfront.net`; this value can
-be retrieved from `distribution.domainName`. CloudFront distributions use a default certificate (`*.cloudfront.net`) to support HTTPS by default. If
-you want to use your own domain name, such as `www.example.com`, you must associate a certificate with your distribution that contains your domain
-name. The certificate must be present in the AWS Certificate Manager (ACM) service in the US East (N. Virginia) region; the certificate may either be
-created by ACM, or created elsewhere and imported into ACM.
+be retrieved from `distribution.distributionDomainName`. CloudFront distributions use a default certificate (`*.cloudfront.net`) to support HTTPS by
+default. If you want to use your own domain name, such as `www.example.com`, you must associate a certificate with your distribution that contains
+your domain name. The certificate must be present in the AWS Certificate Manager (ACM) service in the US East (N. Virginia) region; the certificate
+may either be created by ACM, or created elsewhere and imported into ACM.
 
 ```ts
 const myCertificate = new acm.DnsValidatedCertificate(this, 'mySiteCert', {

diff --git a/packages/@aws-cdk/aws-cloudfront/lib/distribution.ts b/packages/@aws-cdk/aws-cloudfront/lib/distribution.ts
@@ -12,9 +12,17 @@ export interface IDistribution extends IResource {
    * The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
    *
    * @attribute
+   * @deprecated - Use `distributionDomainName` instead.
    */
   readonly domainName: string;
 
+  /**
+   * The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
+   *
+   * @attribute
+   */
+  readonly distributionDomainName: string;
+
   /**
    * The distribution ID for this distribution.
    *
@@ -100,17 +108,20 @@ export class Distribution extends Resource implements IDistribution {
   public static fromDistributionAttributes(scope: Construct, id: string, attrs: DistributionAttributes): IDistribution {
     return new class extends Resource implements IDistribution {
       public readonly domainName: string;
+      public readonly distributionDomainName: string;
       public readonly distributionId: string;
 
       constructor() {
         super(scope, id);
         this.domainName = attrs.domainName;
+        this.distributionDomainName = attrs.domainName;
         this.distributionId = attrs.distributionId;
       }
     }();
   }
 
   public readonly domainName: string;
+  public readonly distributionDomainName: string;
   public readonly distributionId: string;
 
   private readonly defaultBehavior: CacheBehavior;
@@ -152,6 +163,7 @@ export class Distribution extends Resource implements IDistribution {
     } });
 
     this.domainName = distribution.attrDomainName;
+    this.distributionDomainName = distribution.attrDomainName;
     this.distributionId = distribution.ref;
   }
 

diff --git a/packages/@aws-cdk/aws-cloudfront/lib/web_distribution.ts b/packages/@aws-cdk/aws-cloudfront/lib/web_distribution.ts
@@ -677,10 +677,19 @@ export class CloudFrontWebDistribution extends cdk.Resource implements IDistribu
   /**
    * The domain name created by CloudFront for this distribution.
    * If you are using aliases for your distribution, this is the domainName your DNS records should point to.
-   * (In Route53, you could create an ALIAS record to this value, for example. )
+   * (In Route53, you could create an ALIAS record to this value, for example.)
+   *
+   * @deprecated - Use `distributionDomainName` instead.
    */
   public readonly domainName: string;
 
+  /**
+   * The domain name created by CloudFront for this distribution.
+   * If you are using aliases for your distribution, this is the domainName your DNS records should point to.
+   * (In Route53, you could create an ALIAS record to this value, for example.)
+   */
+  public readonly distributionDomainName: string;
+
   /**
    * The distribution ID for this distribution.
    */
@@ -897,6 +906,7 @@ export class CloudFrontWebDistribution extends cdk.Resource implements IDistribu
     const distribution = new CfnDistribution(this, 'CFDistribution', { distributionConfig });
     this.node.defaultChild = distribution;
     this.domainName = distribution.attrDomainName;
+    this.distributionDomainName = distribution.attrDomainName;
     this.distributionId = distribution.ref;
   }