CustomDomainAssociation class
Manages an App Runner Custom Domain association.
> NOTE: After creation, you must use the information in the certificateValidationRecords attribute to add CNAME records to your DNS. For each mapped domain name, add a mapping to the target App Runner subdomain (found in the dnsTarget attribute) and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apprunner.CustomDomainAssociation("example", {
domainName: "example.com",
serviceArn: exampleAwsApprunnerService.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.apprunner.CustomDomainAssociation("example",
domain_name="example.com",
service_arn=example_aws_apprunner_service["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AppRunner.CustomDomainAssociation("example", new()
{
DomainName = "example.com",
ServiceArn = exampleAwsApprunnerService.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apprunner"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apprunner.NewCustomDomainAssociation(ctx, "example", &apprunner.CustomDomainAssociationArgs{
DomainName: pulumi.String("example.com"),
ServiceArn: pulumi.Any(exampleAwsApprunnerService.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apprunner_customdomainassociation" "example" {
domain_name = "example.com"
service_arn = exampleAwsApprunnerService.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.CustomDomainAssociation;
import com.pulumi.aws.apprunner.CustomDomainAssociationArgs;
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 CustomDomainAssociation("example", CustomDomainAssociationArgs.builder()
.domainName("example.com")
.serviceArn(exampleAwsApprunnerService.arn())
.build());
}
}
resources:
example:
type: aws:apprunner:CustomDomainAssociation
properties:
domainName: example.com
serviceArn: ${exampleAwsApprunnerService.arn}
Import
Using pulumi import, import App Runner Custom Domain Associations using the domainName and serviceArn separated by a comma (,). For example:
$ pulumi import aws:apprunner/customDomainAssociation:CustomDomainAssociation example example.com,arn:aws:apprunner:us-east-1:123456789012:service/example-app/8fe1e10304f84fd2b0df550fe98a71fa
Constructors
- CustomDomainAssociation(String name, {CustomDomainAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new CustomDomainAssociation.
nameThe Pulumi resource name.argsArguments used to configure this CustomDomainAssociation. The set of arguments for CustomDomainAssociation.optionsResource options controlling this resource's behavior. - CustomDomainAssociation.reference(String urn)
- Creates a typed reference to an existing CustomDomainAssociation resource.
Properties
-
certificateValidationRecords
↔ Output<
List< CustomDomainAssociationCertificateValidationRecord> > -
Set of certificate CNAME records used for this domain name. See
certificateValidationRecordsBlock below for more details.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dnsTarget
↔ Output<
String> -
App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name. Attribute only available if resource created (not imported) with this provider.
latefinal
-
domainName
↔ Output<
String> -
Custom domain endpoint to association. Specify a base domain e.g.,
example.comor a subdomain e.g.,subdomain.example.com.latefinal -
enableWwwSubdomain
↔ Output<
bool?> -
Whether to associate the subdomain with the App Runner service in addition to the base domain. Defaults to
true.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
-
serviceArn
↔ Output<
String> -
ARN of the App Runner service.
latefinal
-
status
↔ Output<
String> -
Current state of the certificate CNAME record validation. It should change to
SUCCESSafter App Runner completes validation with your DNS.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {CustomDomainAssociationState? state, CustomResourceOptions? options}) → CustomDomainAssociation -
Gets an existing CustomDomainAssociation resource's state with the given
nameandid.