Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. appsync
  5. DomainNameApiAssociation
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.appsync.DomainNameApiAssociation

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an AppSync API Association.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.appsync.DomainNameApiAssociation("example", {
    apiId: exampleAwsAppsyncGraphqlApi.id,
    domainName: exampleAwsAppsyncDomainName.domainName,
});

    import pulumi
import pulumi_aws as aws

example = aws.appsync.DomainNameApiAssociation("example",
    api_id=example_aws_appsync_graphql_api["id"],
    domain_name=example_aws_appsync_domain_name["domainName"])

    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.NewDomainNameApiAssociation(ctx, "example", &appsync.DomainNameApiAssociationArgs{
			ApiId:      pulumi.Any(exampleAwsAppsyncGraphqlApi.Id),
			DomainName: pulumi.Any(exampleAwsAppsyncDomainName.DomainName),
		})
		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.DomainNameApiAssociation("example", new()
    {
        ApiId = exampleAwsAppsyncGraphqlApi.Id,
        DomainName = exampleAwsAppsyncDomainName.DomainName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.DomainNameApiAssociation;
import com.pulumi.aws.appsync.DomainNameApiAssociationArgs;
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 DomainNameApiAssociation("example", DomainNameApiAssociationArgs.builder()
            .apiId(exampleAwsAppsyncGraphqlApi.id())
            .domainName(exampleAwsAppsyncDomainName.domainName())
            .build());

    }
}

    resources:
  example:
    type: aws:appsync:DomainNameApiAssociation
    properties:
      apiId: ${exampleAwsAppsyncGraphqlApi.id}
      domainName: ${exampleAwsAppsyncDomainName.domainName}

    Create DomainNameApiAssociation Resource

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

    Constructor syntax

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

@overload
def DomainNameApiAssociation(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             api_id: Optional[str] = None,
                             domain_name: Optional[str] = None)
    func NewDomainNameApiAssociation(ctx *Context, name string, args DomainNameApiAssociationArgs, opts ...ResourceOption) (*DomainNameApiAssociation, error)
    public DomainNameApiAssociation(string name, DomainNameApiAssociationArgs args, CustomResourceOptions? opts = null)
    public DomainNameApiAssociation(String name, DomainNameApiAssociationArgs args)
public DomainNameApiAssociation(String name, DomainNameApiAssociationArgs args, CustomResourceOptions options)

    type: aws:appsync:DomainNameApiAssociation
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 DomainNameApiAssociationArgs
    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 DomainNameApiAssociationArgs
    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 DomainNameApiAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainNameApiAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainNameApiAssociationArgs
    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 domainNameApiAssociationResource = new Aws.AppSync.DomainNameApiAssociation("domainNameApiAssociationResource", new()
{
    ApiId = "string",
    DomainName = "string",
});

    example, err := appsync.NewDomainNameApiAssociation(ctx, "domainNameApiAssociationResource", &appsync.DomainNameApiAssociationArgs{
	ApiId:      pulumi.String("string"),
	DomainName: pulumi.String("string"),
})

    var domainNameApiAssociationResource = new DomainNameApiAssociation("domainNameApiAssociationResource", DomainNameApiAssociationArgs.builder()
    .apiId("string")
    .domainName("string")
    .build());

    domain_name_api_association_resource = aws.appsync.DomainNameApiAssociation("domainNameApiAssociationResource",
    api_id="string",
    domain_name="string")

    const domainNameApiAssociationResource = new aws.appsync.DomainNameApiAssociation("domainNameApiAssociationResource", {
    apiId: "string",
    domainName: "string",
});

    type: aws:appsync:DomainNameApiAssociation
properties:
    apiId: string
    domainName: string

    DomainNameApiAssociation 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 DomainNameApiAssociation resource accepts the following input properties:

    ApiId string
    API ID.
    DomainName string
    Appsync domain name.
    ApiId string
    API ID.
    DomainName string
    Appsync domain name.
    apiId String
    API ID.
    domainName String
    Appsync domain name.
    apiId string
    API ID.
    domainName string
    Appsync domain name.
    api_id str
    API ID.
    domain_name str
    Appsync domain name.
    apiId String
    API ID.
    domainName String
    Appsync domain name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DomainNameApiAssociation Resource

    Get an existing DomainNameApiAssociation 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?: DomainNameApiAssociationState, opts?: CustomResourceOptions): DomainNameApiAssociation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        domain_name: Optional[str] = None) -> DomainNameApiAssociation
    func GetDomainNameApiAssociation(ctx *Context, name string, id IDInput, state *DomainNameApiAssociationState, opts ...ResourceOption) (*DomainNameApiAssociation, error)
    public static DomainNameApiAssociation Get(string name, Input<string> id, DomainNameApiAssociationState? state, CustomResourceOptions? opts = null)
    public static DomainNameApiAssociation get(String name, Output<String> id, DomainNameApiAssociationState state, CustomResourceOptions options)
    resources:  _:    type: aws:appsync:DomainNameApiAssociation    get:      id: ${id}
    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:
    ApiId string
    API ID.
    DomainName string
    Appsync domain name.
    ApiId string
    API ID.
    DomainName string
    Appsync domain name.
    apiId String
    API ID.
    domainName String
    Appsync domain name.
    apiId string
    API ID.
    domainName string
    Appsync domain name.
    api_id str
    API ID.
    domain_name str
    Appsync domain name.
    apiId String
    API ID.
    domainName String
    Appsync domain name.

    Import

    Using pulumi import, import aws_appsync_domain_name_api_association using the AppSync domain name. For example:

    $ pulumi import aws:appsync/domainNameApiAssociation:DomainNameApiAssociation 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.
    aws logo
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws