1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appsync
  5. DomainName

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.appsync.DomainName

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::AppSync::DomainName

Create DomainName Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DomainName(name: string, args: DomainNameArgs, opts?: CustomResourceOptions);
@overload
def DomainName(resource_name: str,
               args: DomainNameArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def DomainName(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               certificate_arn: Optional[str] = None,
               domain_name: Optional[str] = None,
               description: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:appsync:DomainName
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DomainNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DomainNameArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DomainNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DomainName resource accepts the following input properties:

CertificateArn This property is required. string
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
DomainNameValue This property is required. string
The domain name.
Description string
The decription for your domain name.
Tags List<Pulumi.AwsNative.Inputs.Tag>
A set of tags (key-value pairs) for this domain name.
CertificateArn This property is required. string
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
DomainName This property is required. string
The domain name.
Description string
The decription for your domain name.
Tags TagArgs
A set of tags (key-value pairs) for this domain name.
certificateArn This property is required. String
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
domainName This property is required. String
The domain name.
description String
The decription for your domain name.
tags List<Tag>
A set of tags (key-value pairs) for this domain name.
certificateArn This property is required. string
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
domainName This property is required. string
The domain name.
description string
The decription for your domain name.
tags Tag[]
A set of tags (key-value pairs) for this domain name.
certificate_arn This property is required. str
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
domain_name This property is required. str
The domain name.
description str
The decription for your domain name.
tags Sequence[TagArgs]
A set of tags (key-value pairs) for this domain name.
certificateArn This property is required. String
The Amazon Resource Name (ARN) of the certificate. This will be an AWS Certificate Manager certificate.
domainName This property is required. String
The domain name.
description String
The decription for your domain name.
tags List<Property Map>
A set of tags (key-value pairs) for this 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 provided by AWS AppSync .
DomainNameArn string
The Amazon Resource Name (ARN) for the Domain Name.
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 provided by AWS AppSync .
DomainNameArn string
The Amazon Resource Name (ARN) for the Domain Name.
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 provided by AWS AppSync .
domainNameArn String
The Amazon Resource Name (ARN) for the Domain Name.
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 provided by AWS AppSync .
domainNameArn string
The Amazon Resource Name (ARN) for the Domain Name.
hostedZoneId string
The ID of your Amazon Route 53 hosted zone.
id string
The provider-assigned unique ID for this managed resource.
app_sync_domain_name str
The domain name provided by AWS AppSync .
domain_name_arn str
The Amazon Resource Name (ARN) for the Domain Name.
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 provided by AWS AppSync .
domainNameArn String
The Amazon Resource Name (ARN) for the Domain Name.
hostedZoneId String
The ID of your Amazon Route 53 hosted zone.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi