Package com.pulumi.aws.amplify

Class DomainAssociation

  • public class DomainAssociation
extends com.pulumi.resources.CustomResource
    Provides an Amplify Domain Association resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.amplify.App;
 import com.pulumi.aws.amplify.AppArgs;
 import com.pulumi.aws.amplify.inputs.AppCustomRuleArgs;
 import com.pulumi.aws.amplify.Branch;
 import com.pulumi.aws.amplify.BranchArgs;
 import com.pulumi.aws.amplify.DomainAssociation;
 import com.pulumi.aws.amplify.DomainAssociationArgs;
 import com.pulumi.aws.amplify.inputs.DomainAssociationSubDomainArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new App("example", AppArgs.builder()
             .customRules(AppCustomRuleArgs.builder()
                 .source("https://example.com")
                 .status("302")
                 .target("https://www.example.com")
                 .build())
             .name("app")
             .build());
 
         var master = new Branch("master", BranchArgs.builder()
             .appId(example.id())
             .branchName("master")
             .build());
 
         var exampleDomainAssociation = new DomainAssociation("exampleDomainAssociation", DomainAssociationArgs.builder()
             .subDomains(            
                 DomainAssociationSubDomainArgs.builder()
                     .branchName(master.branchName())
                     .prefix("")
                     .build(),
                 DomainAssociationSubDomainArgs.builder()
                     .branchName(master.branchName())
                     .prefix("www")
                     .build())
             .appId(example.id())
             .domainName("example.com")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Amplify domain association using `appId` and `domainName`. For example: ```sh $ pulumi import aws:amplify/domainAssociation:DomainAssociation app d2ypk4k47z8u6/example.com ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> appId()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<DomainAssociationCertificateSettings> certificateSettings()  
      com.pulumi.core.Output<java.lang.String> certificateVerificationDnsRecord()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableAutoSubDomain()  
      static DomainAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DomainAssociationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<DomainAssociationSubDomain>> subDomains()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> waitForVerification()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DomainAssociation

        public DomainAssociation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • DomainAssociation

        public DomainAssociation​(java.lang.String name,
                         DomainAssociationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • DomainAssociation

        public DomainAssociation​(java.lang.String name,
                         DomainAssociationArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • appId

        public com.pulumi.core.Output<java.lang.String> appId()
        Returns:
        Unique ID for an Amplify app.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN for the domain association.

      • certificateSettings

        public com.pulumi.core.Output<DomainAssociationCertificateSettings> certificateSettings()
        Returns:
        The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

      • certificateVerificationDnsRecord

        public com.pulumi.core.Output<java.lang.String> certificateVerificationDnsRecord()
        Returns:
        DNS records for certificate verification in a space-delimited format (`<record> CNAME <target>`).

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Domain name for the domain association.

      • enableAutoSubDomain

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableAutoSubDomain()
        Returns:
        Enables the automated creation of subdomains for branches.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • subDomains

        public com.pulumi.core.Output<java.util.List<DomainAssociationSubDomain>> subDomains()
        Returns:
        Setting for the subdomain. Documented below.

      • waitForVerification

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> waitForVerification()
        Returns:
        If enabled, the resource will wait for the domain association status to change to `PENDING_DEPLOYMENT` or `AVAILABLE`. Setting this to `false` will skip the process. Default: `true`.

      • get

        public static DomainAssociation get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    DomainAssociationState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.