getDomainName

Use this data source to get the custom domain name for use with AWS API Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.apigateway.getDomainName({
domainName: "api.example.com",
});
import pulumi
import pulumi_aws as aws
example = aws.apigateway.get_domain_name(domain_name="api.example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.ApiGateway.GetDomainName.Invoke(new()
{
DomainName = "api.example.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.LookupDomainName(ctx, &apigateway.LookupDomainNameArgs{
DomainName: "api.example.com",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetDomainNameArgs;
import java.util.List;
import java.util.ArrayList;
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) {
final var example = ApigatewayFunctions.getDomainName(GetDomainNameArgs.builder()
.domainName("api.example.com")
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:apigateway:getDomainName
Arguments:
domainName: api.example.com

Return

A collection of values returned by getDomainName.

Parameters

argument

A collection of arguments for invoking getDomainName.


suspend fun getDomainName(domainName: String, tags: Map<String, String>? = null): GetDomainNameResult

Return

A collection of values returned by getDomainName.

Parameters

domainName

Fully-qualified domain name to look up. If no domain name is found, an error will be returned.

tags

Key-value map of tags for the resource.

See also


Return

A collection of values returned by getDomainName.

Parameters

argument

Builder for com.pulumi.aws.apigateway.kotlin.inputs.GetDomainNamePlainArgs.

See also