DomainAssociation class

Provides an Amplify Domain Association resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.amplify.App("example", {
    customRules: [{
        source: "https://example.com",
        status: "302",
        target: "https://www.example.com",
    }],
    name: "app",
});
const master = new aws.amplify.Branch("master", {
    appId: example.id,
    branchName: "master",
});
const exampleDomainAssociation = new aws.amplify.DomainAssociation("example", {
    subDomains: [
        {
            branchName: master.branchName,
            prefix: "",
        },
        {
            branchName: master.branchName,
            prefix: "www",
        },
    ],
    appId: example.id,
    domainName: "example.com",
});
import pulumi
import pulumi_aws as aws

example = aws.amplify.App("example",
    custom_rules=[{
        "source": "https://example.com",
        "status": "302",
        "target": "https://www.example.com",
    }],
    name="app")
master = aws.amplify.Branch("master",
    app_id=example.id,
    branch_name="master")
example_domain_association = aws.amplify.DomainAssociation("example",
    sub_domains=[
        {
            "branch_name": master.branch_name,
            "prefix": "",
        },
        {
            "branch_name": master.branch_name,
            "prefix": "www",
        },
    ],
    app_id=example.id,
    domain_name="example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Amplify.App("example", new()
    {
        CustomRules = new[]
        {
            new Aws.Amplify.Inputs.AppCustomRuleArgs
            {
                Source = "https://example.com",
                Status = "302",
                Target = "https://www.example.com",
            },
        },
        Name = "app",
    });

    var master = new Aws.Amplify.Branch("master", new()
    {
        AppId = example.Id,
        BranchName = "master",
    });

    var exampleDomainAssociation = new Aws.Amplify.DomainAssociation("example", new()
    {
        SubDomains = new[]
        {
            new Aws.Amplify.Inputs.DomainAssociationSubDomainArgs
            {
                BranchName = master.BranchName,
                Prefix = "",
            },
            new Aws.Amplify.Inputs.DomainAssociationSubDomainArgs
            {
                BranchName = master.BranchName,
                Prefix = "www",
            },
        },
        AppId = example.Id,
        DomainName = "example.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amplify"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := amplify.NewApp(ctx, "example", &amplify.AppArgs{
			CustomRules: amplify.AppCustomRuleArray{
				&amplify.AppCustomRuleArgs{
					Source: pulumi.String("https://example.com"),
					Status: pulumi.String("302"),
					Target: pulumi.String("https://www.example.com"),
				},
			},
			Name: pulumi.String("app"),
		})
		if err != nil {
			return err
		}
		master, err := amplify.NewBranch(ctx, "master", &amplify.BranchArgs{
			AppId:      example.ID().ToIDOutput().ToStringOutput(),
			BranchName: pulumi.String("master"),
		})
		if err != nil {
			return err
		}
		_, err = amplify.NewDomainAssociation(ctx, "example", &amplify.DomainAssociationArgs{
			SubDomains: amplify.DomainAssociationSubDomainArray{
				&amplify.DomainAssociationSubDomainArgs{
					BranchName: master.BranchName,
					Prefix:     pulumi.String(""),
				},
				&amplify.DomainAssociationSubDomainArgs{
					BranchName: master.BranchName,
					Prefix:     pulumi.String("www"),
				},
			},
			AppId:      example.ID().ToIDOutput().ToStringOutput(),
			DomainName: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_amplify_app" "example" {
  custom_rules {
    source = "https://example.com"
    status = "302"
    target = "https://www.example.com"
  }
  name = "app"
}
resource "aws_amplify_branch" "master" {
  app_id      = aws_amplify_app.example.id
  branch_name = "master"
}
resource "aws_amplify_domainassociation" "example" {
  sub_domains {
    branch_name = aws_amplify_branch.master.branch_name
    prefix      = ""
  }
  sub_domains {
    branch_name = aws_amplify_branch.master.branch_name
    prefix      = "www"
  }
  app_id      = aws_amplify_app.example.id
  domain_name = "example.com"
}
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());

    }
}
resources:
  example:
    type: aws:amplify:App
    properties:
      customRules:
        - source: https://example.com
          status: '302'
          target: https://www.example.com
      name: app
  master:
    type: aws:amplify:Branch
    properties:
      appId: ${example.id}
      branchName: master
  exampleDomainAssociation:
    type: aws:amplify:DomainAssociation
    name: example
    properties:
      subDomains:
        - branchName: ${master.branchName}
          prefix: ""
        - branchName: ${master.branchName}
          prefix: www
      appId: ${example.id}
      domainName: example.com

Import

Using pulumi import, import Amplify domain association using appId and domainName. For example:

$ pulumi import aws:amplify/domainAssociation:DomainAssociation app d2ypk4k47z8u6/example.com

Constructors

DomainAssociation(String name, {DomainAssociationArgs? args, CustomResourceOptions? options})
Creates a new DomainAssociation. name The Pulumi resource name. args Arguments used to configure this DomainAssociation. The set of arguments for DomainAssociation. options Resource options controlling this resource's behavior.
DomainAssociation.reference(String urn)
Creates a typed reference to an existing DomainAssociation resource.

Properties

appId ↔ Output<String>
Unique ID for an Amplify app.
latefinal
arn ↔ Output<String>
ARN for the domain association.
latefinal
certificateSettings ↔ Output<DomainAssociationCertificateSettings>
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.
latefinal
certificateVerificationDnsRecord ↔ Output<String>
DNS records for certificate verification in a space-delimited format (&lt;record&gt; CNAME &lt;target&gt;).
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
Domain name for the domain association.
latefinal
enableAutoSubDomain ↔ Output<bool?>
Enables the automated creation of subdomains for branches.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subDomains ↔ Output<List<DomainAssociationSubDomain>>
Setting for the subdomain. Documented below.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
waitForVerification ↔ Output<bool?>
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.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DomainAssociationState? state, CustomResourceOptions? options}) → DomainAssociation
Gets an existing DomainAssociation resource's state with the given name and id.