DomainName class
Manages an Amazon API Gateway Version 2 domain name. More information can be found in the Amazon API Gateway Developer Guide.
> Note: This resource establishes ownership of and the TLS settings for
a particular domain name. An API stage can be associated with the domain name using the aws.apigatewayv2.ApiMapping resource.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.DomainName("example", {
domainNameConfiguration: {
certificateArn: exampleAwsAcmCertificate.arn,
endpointType: "REGIONAL",
securityPolicy: "TLS_1_2",
},
domainName: "ws-api.example.com",
});
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.DomainName("example",
domain_name_configuration={
"certificate_arn": example_aws_acm_certificate["arn"],
"endpoint_type": "REGIONAL",
"security_policy": "TLS_1_2",
},
domain_name="ws-api.example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.DomainName("example", new()
{
DomainNameConfiguration = new Aws.ApiGatewayV2.Inputs.DomainNameDomainNameConfigurationArgs
{
CertificateArn = exampleAwsAcmCertificate.Arn,
EndpointType = "REGIONAL",
SecurityPolicy = "TLS_1_2",
},
Domain = "ws-api.example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigatewayv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigatewayv2.NewDomainName(ctx, "example", &apigatewayv2.DomainNameArgs{
DomainNameConfiguration: &apigatewayv2.DomainNameDomainNameConfigurationArgs{
CertificateArn: pulumi.Any(exampleAwsAcmCertificate.Arn),
EndpointType: pulumi.String("REGIONAL"),
SecurityPolicy: pulumi.String("TLS_1_2"),
},
DomainName: pulumi.String("ws-api.example.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigatewayv2_domainname" "example" {
domain_name_configuration = {
certificate_arn = exampleAwsAcmCertificate.arn
endpoint_type = "REGIONAL"
security_policy = "TLS_1_2"
}
domain_name = "ws-api.example.com"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.DomainName;
import com.pulumi.aws.apigatewayv2.DomainNameArgs;
import com.pulumi.aws.apigatewayv2.inputs.DomainNameDomainNameConfigurationArgs;
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 DomainName("example", DomainNameArgs.builder()
.domainNameConfiguration(DomainNameDomainNameConfigurationArgs.builder()
.certificateArn(exampleAwsAcmCertificate.arn())
.endpointType("REGIONAL")
.securityPolicy("TLS_1_2")
.build())
.domainName("ws-api.example.com")
.build());
}
}
resources:
example:
type: aws:apigatewayv2:DomainName
properties:
domainNameConfiguration:
certificateArn: ${exampleAwsAcmCertificate.arn}
endpointType: REGIONAL
securityPolicy: TLS_1_2
domainName: ws-api.example.com
Associated Route 53 Resource Record
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.DomainName("example", {
domainNameConfiguration: {
certificateArn: exampleAwsAcmCertificate.arn,
endpointType: "REGIONAL",
securityPolicy: "TLS_1_2",
},
domainName: "http-api.example.com",
});
const exampleRecord = new aws.route53.Record("example", {
aliases: [{
name: example.domainNameConfiguration.targetDomainName,
zoneId: example.domainNameConfiguration.hostedZoneId,
evaluateTargetHealth: false,
}],
name: example.domainName,
type: aws.route53.RecordType.A,
zoneId: exampleAwsRoute53Zone.zoneId,
});
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.DomainName("example",
domain_name_configuration={
"certificate_arn": example_aws_acm_certificate["arn"],
"endpoint_type": "REGIONAL",
"security_policy": "TLS_1_2",
},
domain_name="http-api.example.com")
example_record = aws.route53.Record("example",
aliases=[{
"name": example.domain_name_configuration.target_domain_name,
"zone_id": example.domain_name_configuration.hosted_zone_id,
"evaluate_target_health": False,
}],
name=example.domain_name,
type=aws.route53.RecordType.A,
zone_id=example_aws_route53_zone["zoneId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.DomainName("example", new()
{
DomainNameConfiguration = new Aws.ApiGatewayV2.Inputs.DomainNameDomainNameConfigurationArgs
{
CertificateArn = exampleAwsAcmCertificate.Arn,
EndpointType = "REGIONAL",
SecurityPolicy = "TLS_1_2",
},
Domain = "http-api.example.com",
});
var exampleRecord = new Aws.Route53.Record("example", new()
{
Aliases = new[]
{
new Aws.Route53.Inputs.RecordAliasArgs
{
Name = example.DomainNameConfiguration.Apply(domainNameConfiguration => domainNameConfiguration.TargetDomainName),
ZoneId = example.DomainNameConfiguration.Apply(domainNameConfiguration => domainNameConfiguration.HostedZoneId),
EvaluateTargetHealth = false,
},
},
Name = example.Domain,
Type = Aws.Route53.RecordType.A,
ZoneId = exampleAwsRoute53Zone.ZoneId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigatewayv2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := apigatewayv2.NewDomainName(ctx, "example", &apigatewayv2.DomainNameArgs{
DomainNameConfiguration: &apigatewayv2.DomainNameDomainNameConfigurationArgs{
CertificateArn: pulumi.Any(exampleAwsAcmCertificate.Arn),
EndpointType: pulumi.String("REGIONAL"),
SecurityPolicy: pulumi.String("TLS_1_2"),
},
DomainName: pulumi.String("http-api.example.com"),
})
if err != nil {
return err
}
_, err = route53.NewRecord(ctx, "example", &route53.RecordArgs{
Aliases: route53.RecordAliasArray{
&route53.RecordAliasArgs{
Name: example.DomainNameConfiguration.TargetDomainName(),
ZoneId: example.DomainNameConfiguration.HostedZoneId(),
EvaluateTargetHealth: pulumi.Bool(false),
},
},
Name: example.DomainName,
Type: pulumi.String(route53.RecordTypeA),
ZoneId: pulumi.Any(exampleAwsRoute53Zone.ZoneId),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigatewayv2_domainname" "example" {
domain_name_configuration = {
certificate_arn = exampleAwsAcmCertificate.arn
endpoint_type = "REGIONAL"
security_policy = "TLS_1_2"
}
domain_name = "http-api.example.com"
}
resource "aws_route53_record" "example" {
aliases {
name = aws_apigatewayv2_domainname.example.domain_name_configuration.target_domain_name
zone_id = aws_apigatewayv2_domainname.example.domain_name_configuration.hosted_zone_id
evaluate_target_health = false
}
name = aws_apigatewayv2_domainname.example.domain_name
type = "A"
zone_id = exampleAwsRoute53Zone.zoneId
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.DomainName;
import com.pulumi.aws.apigatewayv2.DomainNameArgs;
import com.pulumi.aws.apigatewayv2.inputs.DomainNameDomainNameConfigurationArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
import com.pulumi.aws.route53.inputs.RecordAliasArgs;
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 DomainName("example", DomainNameArgs.builder()
.domainNameConfiguration(DomainNameDomainNameConfigurationArgs.builder()
.certificateArn(exampleAwsAcmCertificate.arn())
.endpointType("REGIONAL")
.securityPolicy("TLS_1_2")
.build())
.domainName("http-api.example.com")
.build());
var exampleRecord = new Record("exampleRecord", RecordArgs.builder()
.aliases(RecordAliasArgs.builder()
.name(example.domainNameConfiguration().applyValue(_domainNameConfiguration -> _domainNameConfiguration.targetDomainName()))
.zoneId(example.domainNameConfiguration().applyValue(_domainNameConfiguration -> _domainNameConfiguration.hostedZoneId()))
.evaluateTargetHealth(false)
.build())
.name(example.domainName())
.type("A")
.zoneId(exampleAwsRoute53Zone.zoneId())
.build());
}
}
resources:
example:
type: aws:apigatewayv2:DomainName
properties:
domainNameConfiguration:
certificateArn: ${exampleAwsAcmCertificate.arn}
endpointType: REGIONAL
securityPolicy: TLS_1_2
domainName: http-api.example.com
exampleRecord:
type: aws:route53:Record
name: example
properties:
aliases:
- name: ${example.domainNameConfiguration.targetDomainName}
zoneId: ${example.domainNameConfiguration.hostedZoneId}
evaluateTargetHealth: false
name: ${example.domainName}
type: A
zoneId: ${exampleAwsRoute53Zone.zoneId}
Import
Using pulumi import, import aws.apigatewayv2.DomainName using the domain name. For example:
$ pulumi import aws:apigatewayv2/domainName:DomainName example ws-api.example.com
Constructors
- DomainName(String name, {DomainNameArgs? args, CustomResourceOptions? options})
-
Creates a new DomainName.
nameThe Pulumi resource name.argsArguments used to configure this DomainName. The set of arguments for DomainName.optionsResource options controlling this resource's behavior. - DomainName.reference(String urn)
- Creates a typed reference to an existing DomainName resource.
Properties
-
apiMappingSelectionExpression
↔ Output<
String> -
API mapping selection expression for the domain name.
latefinal
-
arn
↔ Output<
String> -
ARN of the domain name.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
Domain name. Must be between 1 and 512 characters in length.
latefinal
-
domainNameConfiguration
↔ Output<
DomainNameDomainNameConfiguration> -
Domain name configuration. See below.
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
-
mutualTlsAuthentication
↔ Output<
DomainNameMutualTlsAuthentication?> -
Mutual TLS authentication configuration for the domain name.
latefinal
-
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
-
routingMode
↔ Output<
String> -
Mode to route traffic for the domain name. Valid values:
API_MAPPING_ONLY,ROUTING_RULE_ONLY,ROUTING_RULE_THEN_API_MAPPING.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags to assign to the domain name. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.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, {DomainNameState? state, CustomResourceOptions? options}) → DomainName -
Gets an existing DomainName resource's state with the given
nameandid.