AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Wednesday, May 25, 2022 by Pulumi

DomainName

Provides an AppSync Domain Name.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.AppSync.DomainName("example", new Aws.AppSync.DomainNameArgs
        {
            DomainName = "api.example.com",
            CertificateArn = aws_acm_certificate.Example.Arn,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/appsync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appsync.NewDomainName(ctx, "example", &appsync.DomainNameArgs{
			DomainName:     pulumi.String("api.example.com"),
			CertificateArn: pulumi.Any(aws_acm_certificate.Example.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .domainName("api.example.com")
            .certificateArn(aws_acm_certificate.example().arn())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.appsync.DomainName("example",
    domain_name="api.example.com",
    certificate_arn=aws_acm_certificate["example"]["arn"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.appsync.DomainName("example", {
    domainName: "api.example.com",
    certificateArn: aws_acm_certificate.example.arn,
});
resources:
  example:
    type: aws:appsync:DomainName
    properties:
      domainName: api.example.com
      certificateArn: ${aws_acm_certificate.example.arn}

Create a DomainName Resource

new DomainName(name: string, args: DomainNameArgs, opts?: CustomResourceOptions);
@overload
def DomainName(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               certificate_arn: Optional[str] = None,
               description: Optional[str] = None,
               domain_name: Optional[str] = None)
@overload
def DomainName(resource_name: str,
               args: DomainNameArgs,
               opts: Optional[ResourceOptions] = None)
func NewDomainName(ctx *Context, name string, args DomainNameArgs, opts ...ResourceOption) (*DomainName, error)
public DomainName(string name, DomainNameArgs args, CustomResourceOptions? opts = null)
public DomainName(String name, DomainNameArgs args)
public DomainName(String name, DomainNameArgs args, CustomResourceOptions options)
type: aws:appsync:DomainName
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DomainNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DomainNameArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DomainNameArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DomainNameArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DomainName Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DomainName resource accepts the following input properties:

CertificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

Name string

The domain name.

Description string

A description of the Domain Name.

CertificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

DomainName string

The domain name.

Description string

A description of the Domain Name.

certificateArn String

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

domainName String

The domain name.

description String

A description of the Domain Name.

certificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

domainName string

The domain name.

description string

A description of the Domain Name.

certificate_arn str

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

domain_name str

The domain name.

description str

A description of the Domain Name.

certificateArn String

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

domainName String

The domain name.

description String

A description of the Domain Name.

Outputs

All input properties are implicitly available as output properties. Additionally, the DomainName resource produces the following output properties:

AppsyncDomainName string

The domain name that AppSync provides.

HostedZoneId string

The ID of your Amazon Route 53 hosted zone.

Id string

The provider-assigned unique ID for this managed resource.

AppsyncDomainName string

The domain name that AppSync provides.

HostedZoneId string

The ID of your Amazon Route 53 hosted zone.

Id string

The provider-assigned unique ID for this managed resource.

appsyncDomainName String

The domain name that AppSync provides.

hostedZoneId String

The ID of your Amazon Route 53 hosted zone.

id String

The provider-assigned unique ID for this managed resource.

appsyncDomainName string

The domain name that AppSync provides.

hostedZoneId string

The ID of your Amazon Route 53 hosted zone.

id string

The provider-assigned unique ID for this managed resource.

appsync_domain_name str

The domain name that AppSync provides.

hosted_zone_id str

The ID of your Amazon Route 53 hosted zone.

id str

The provider-assigned unique ID for this managed resource.

appsyncDomainName String

The domain name that AppSync provides.

hostedZoneId String

The ID of your Amazon Route 53 hosted zone.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing DomainName Resource

Get an existing DomainName resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DomainNameState, opts?: CustomResourceOptions): DomainName
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        appsync_domain_name: Optional[str] = None,
        certificate_arn: Optional[str] = None,
        description: Optional[str] = None,
        domain_name: Optional[str] = None,
        hosted_zone_id: Optional[str] = None) -> DomainName
func GetDomainName(ctx *Context, name string, id IDInput, state *DomainNameState, opts ...ResourceOption) (*DomainName, error)
public static DomainName Get(string name, Input<string> id, DomainNameState? state, CustomResourceOptions? opts = null)
public static DomainName get(String name, Output<String> id, DomainNameState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppsyncDomainName string

The domain name that AppSync provides.

CertificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

Description string

A description of the Domain Name.

HostedZoneId string

The ID of your Amazon Route 53 hosted zone.

Name string

The domain name.

AppsyncDomainName string

The domain name that AppSync provides.

CertificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

Description string

A description of the Domain Name.

DomainName string

The domain name.

HostedZoneId string

The ID of your Amazon Route 53 hosted zone.

appsyncDomainName String

The domain name that AppSync provides.

certificateArn String

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

description String

A description of the Domain Name.

domainName String

The domain name.

hostedZoneId String

The ID of your Amazon Route 53 hosted zone.

appsyncDomainName string

The domain name that AppSync provides.

certificateArn string

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

description string

A description of the Domain Name.

domainName string

The domain name.

hostedZoneId string

The ID of your Amazon Route 53 hosted zone.

appsync_domain_name str

The domain name that AppSync provides.

certificate_arn str

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

description str

A description of the Domain Name.

domain_name str

The domain name.

hosted_zone_id str

The ID of your Amazon Route 53 hosted zone.

appsyncDomainName String

The domain name that AppSync provides.

certificateArn String

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1.

description String

A description of the Domain Name.

domainName String

The domain name.

hostedZoneId String

The ID of your Amazon Route 53 hosted zone.

Import

aws_appsync_domain_name can be imported using the AppSync domain name, e.g.,

 $ pulumi import aws:appsync/domainName:DomainName example example.com

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.