aws.appsync.DomainName
Explore with Pulumi AI
Provides an AppSync Domain Name.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.appsync.DomainName("example", {
domainName: "api.example.com",
certificateArn: exampleAwsAcmCertificate.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.appsync.DomainName("example",
domain_name="api.example.com",
certificate_arn=example_aws_acm_certificate["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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(exampleAwsAcmCertificate.Arn),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AppSync.DomainName("example", new()
{
Name = "api.example.com",
CertificateArn = exampleAwsAcmCertificate.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.DomainName;
import com.pulumi.aws.appsync.DomainNameArgs;
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) {
var example = new DomainName("example", DomainNameArgs.builder()
.domainName("api.example.com")
.certificateArn(exampleAwsAcmCertificate.arn())
.build());
}
}
resources:
example:
type: aws:appsync:DomainName
properties:
domainName: api.example.com
certificateArn: ${exampleAwsAcmCertificate.arn}
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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampledomainNameResourceResourceFromAppsyncdomainName = new Aws.AppSync.DomainName("exampledomainNameResourceResourceFromAppsyncdomainName", new()
{
CertificateArn = "string",
Name = "string",
Description = "string",
});
example, err := appsync.NewDomainName(ctx, "exampledomainNameResourceResourceFromAppsyncdomainName", &appsync.DomainNameArgs{
CertificateArn: pulumi.String("string"),
DomainName: pulumi.String("string"),
Description: pulumi.String("string"),
})
var exampledomainNameResourceResourceFromAppsyncdomainName = new DomainName("exampledomainNameResourceResourceFromAppsyncdomainName", DomainNameArgs.builder()
.certificateArn("string")
.domainName("string")
.description("string")
.build());
exampledomain_name_resource_resource_from_appsyncdomain_name = aws.appsync.DomainName("exampledomainNameResourceResourceFromAppsyncdomainName",
certificate_arn="string",
domain_name="string",
description="string")
const exampledomainNameResourceResourceFromAppsyncdomainName = new aws.appsync.DomainName("exampledomainNameResourceResourceFromAppsyncdomainName", {
certificateArn: "string",
domainName: "string",
description: "string",
});
type: aws:appsync:DomainName
properties:
certificateArn: string
description: string
domainName: string
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:
- Certificate
Arn string - 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
- Domain name.
- Description string
- A description of the Domain Name.
- Certificate
Arn string - 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 string - Domain name.
- Description string
- A description of the Domain Name.
- certificate
Arn String - 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 String - Domain name.
- description String
- A description of the Domain Name.
- certificate
Arn string - 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 string - Domain name.
- description string
- A description of the Domain Name.
- certificate_
arn str - 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 - Domain name.
- description str
- A description of the Domain Name.
- certificate
Arn String - 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 String - 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:
- Appsync
Domain stringName - Domain name that AppSync provides.
- Hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- Id string
- The provider-assigned unique ID for this managed resource.
- Appsync
Domain stringName - Domain name that AppSync provides.
- Hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- Id string
- The provider-assigned unique ID for this managed resource.
- appsync
Domain StringName - Domain name that AppSync provides.
- hosted
Zone StringId - ID of your Amazon Route 53 hosted zone.
- id String
- The provider-assigned unique ID for this managed resource.
- appsync
Domain stringName - Domain name that AppSync provides.
- hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- id string
- The provider-assigned unique ID for this managed resource.
- appsync_
domain_ strname - Domain name that AppSync provides.
- hosted_
zone_ strid - ID of your Amazon Route 53 hosted zone.
- id str
- The provider-assigned unique ID for this managed resource.
- appsync
Domain StringName - Domain name that AppSync provides.
- hosted
Zone StringId - ID of your Amazon Route 53 hosted zone.
- id String
- The provider-assigned unique ID for this managed resource.
Look up 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.
- Appsync
Domain stringName - Domain name that AppSync provides.
- Certificate
Arn string - 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.
- Hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- Name string
- Domain name.
- Appsync
Domain stringName - Domain name that AppSync provides.
- Certificate
Arn string - 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.
- Domain
Name string - Domain name.
- Hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- appsync
Domain StringName - Domain name that AppSync provides.
- certificate
Arn String - 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.
- domain
Name String - Domain name.
- hosted
Zone StringId - ID of your Amazon Route 53 hosted zone.
- appsync
Domain stringName - Domain name that AppSync provides.
- certificate
Arn string - 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.
- domain
Name string - Domain name.
- hosted
Zone stringId - ID of your Amazon Route 53 hosted zone.
- appsync_
domain_ strname - Domain name that AppSync provides.
- certificate_
arn str - 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 - Domain name.
- hosted_
zone_ strid - ID of your Amazon Route 53 hosted zone.
- appsync
Domain StringName - Domain name that AppSync provides.
- certificate
Arn String - 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.
- domain
Name String - Domain name.
- hosted
Zone StringId - ID of your Amazon Route 53 hosted zone.
Import
Using pulumi import
, import aws_appsync_domain_name
using the AppSync domain name. For example:
$ pulumi import aws:appsync/domainName:DomainName example example.com
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.