Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshiftserverless
  5. CustomDomainAssociation
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshiftserverless.CustomDomainAssociation

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Redshift Serverless Custom Domain Association.

    Example Usage

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

const example = new aws.acm.Certificate("example", {domainName: "example.com"});
const exampleNamespace = new aws.redshiftserverless.Namespace("example", {namespaceName: "example-namespace"});
const exampleWorkgroup = new aws.redshiftserverless.Workgroup("example", {
    workgroupName: "example-workgroup",
    namespaceName: exampleNamespace.namespaceName,
});
const exampleCustomDomainAssociation = new aws.redshiftserverless.CustomDomainAssociation("example", {
    workgroupName: exampleWorkgroup.workgroupName,
    customDomainName: "example.com",
    customDomainCertificateArn: example.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.acm.Certificate("example", domain_name="example.com")
example_namespace = aws.redshiftserverless.Namespace("example", namespace_name="example-namespace")
example_workgroup = aws.redshiftserverless.Workgroup("example",
    workgroup_name="example-workgroup",
    namespace_name=example_namespace.namespace_name)
example_custom_domain_association = aws.redshiftserverless.CustomDomainAssociation("example",
    workgroup_name=example_workgroup.workgroup_name,
    custom_domain_name="example.com",
    custom_domain_certificate_arn=example.arn)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/acm"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshiftserverless"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := acm.NewCertificate(ctx, "example", &acm.CertificateArgs{
			DomainName: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := redshiftserverless.NewNamespace(ctx, "example", &redshiftserverless.NamespaceArgs{
			NamespaceName: pulumi.String("example-namespace"),
		})
		if err != nil {
			return err
		}
		exampleWorkgroup, err := redshiftserverless.NewWorkgroup(ctx, "example", &redshiftserverless.WorkgroupArgs{
			WorkgroupName: pulumi.String("example-workgroup"),
			NamespaceName: exampleNamespace.NamespaceName,
		})
		if err != nil {
			return err
		}
		_, err = redshiftserverless.NewCustomDomainAssociation(ctx, "example", &redshiftserverless.CustomDomainAssociationArgs{
			WorkgroupName:              exampleWorkgroup.WorkgroupName,
			CustomDomainName:           pulumi.String("example.com"),
			CustomDomainCertificateArn: example.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.Acm.Certificate("example", new()
    {
        DomainName = "example.com",
    });

    var exampleNamespace = new Aws.RedshiftServerless.Namespace("example", new()
    {
        NamespaceName = "example-namespace",
    });

    var exampleWorkgroup = new Aws.RedshiftServerless.Workgroup("example", new()
    {
        WorkgroupName = "example-workgroup",
        NamespaceName = exampleNamespace.NamespaceName,
    });

    var exampleCustomDomainAssociation = new Aws.RedshiftServerless.CustomDomainAssociation("example", new()
    {
        WorkgroupName = exampleWorkgroup.WorkgroupName,
        CustomDomainName = "example.com",
        CustomDomainCertificateArn = example.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.acm.Certificate;
import com.pulumi.aws.acm.CertificateArgs;
import com.pulumi.aws.redshiftserverless.Namespace;
import com.pulumi.aws.redshiftserverless.NamespaceArgs;
import com.pulumi.aws.redshiftserverless.Workgroup;
import com.pulumi.aws.redshiftserverless.WorkgroupArgs;
import com.pulumi.aws.redshiftserverless.CustomDomainAssociation;
import com.pulumi.aws.redshiftserverless.CustomDomainAssociationArgs;
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 Certificate("example", CertificateArgs.builder()
            .domainName("example.com")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
            .namespaceName("example-namespace")
            .build());

        var exampleWorkgroup = new Workgroup("exampleWorkgroup", WorkgroupArgs.builder()
            .workgroupName("example-workgroup")
            .namespaceName(exampleNamespace.namespaceName())
            .build());

        var exampleCustomDomainAssociation = new CustomDomainAssociation("exampleCustomDomainAssociation", CustomDomainAssociationArgs.builder()
            .workgroupName(exampleWorkgroup.workgroupName())
            .customDomainName("example.com")
            .customDomainCertificateArn(example.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:acm:Certificate
    properties:
      domainName: example.com
  exampleNamespace:
    type: aws:redshiftserverless:Namespace
    name: example
    properties:
      namespaceName: example-namespace
  exampleWorkgroup:
    type: aws:redshiftserverless:Workgroup
    name: example
    properties:
      workgroupName: example-workgroup
      namespaceName: ${exampleNamespace.namespaceName}
  exampleCustomDomainAssociation:
    type: aws:redshiftserverless:CustomDomainAssociation
    name: example
    properties:
      workgroupName: ${exampleWorkgroup.workgroupName}
      customDomainName: example.com
      customDomainCertificateArn: ${example.arn}

    Create CustomDomainAssociation Resource

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

    Constructor syntax

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

@overload
def CustomDomainAssociation(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            custom_domain_certificate_arn: Optional[str] = None,
                            custom_domain_name: Optional[str] = None,
                            workgroup_name: Optional[str] = None)
    func NewCustomDomainAssociation(ctx *Context, name string, args CustomDomainAssociationArgs, opts ...ResourceOption) (*CustomDomainAssociation, error)
    public CustomDomainAssociation(string name, CustomDomainAssociationArgs args, CustomResourceOptions? opts = null)
    public CustomDomainAssociation(String name, CustomDomainAssociationArgs args)
public CustomDomainAssociation(String name, CustomDomainAssociationArgs args, CustomResourceOptions options)

    type: aws:redshiftserverless:CustomDomainAssociation
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 CustomDomainAssociationArgs
    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 CustomDomainAssociationArgs
    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 CustomDomainAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDomainAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDomainAssociationArgs
    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 awsCustomDomainAssociationResource = new Aws.RedshiftServerless.CustomDomainAssociation("awsCustomDomainAssociationResource", new()
{
    CustomDomainCertificateArn = "string",
    CustomDomainName = "string",
    WorkgroupName = "string",
});

    example, err := redshiftserverless.NewCustomDomainAssociation(ctx, "awsCustomDomainAssociationResource", &redshiftserverless.CustomDomainAssociationArgs{
	CustomDomainCertificateArn: pulumi.String("string"),
	CustomDomainName:           pulumi.String("string"),
	WorkgroupName:              pulumi.String("string"),
})

    var awsCustomDomainAssociationResource = new CustomDomainAssociation("awsCustomDomainAssociationResource", CustomDomainAssociationArgs.builder()
    .customDomainCertificateArn("string")
    .customDomainName("string")
    .workgroupName("string")
    .build());

    aws_custom_domain_association_resource = aws.redshiftserverless.CustomDomainAssociation("awsCustomDomainAssociationResource",
    custom_domain_certificate_arn="string",
    custom_domain_name="string",
    workgroup_name="string")

    const awsCustomDomainAssociationResource = new aws.redshiftserverless.CustomDomainAssociation("awsCustomDomainAssociationResource", {
    customDomainCertificateArn: "string",
    customDomainName: "string",
    workgroupName: "string",
});

    type: aws:redshiftserverless:CustomDomainAssociation
properties:
    customDomainCertificateArn: string
    customDomainName: string
    workgroupName: string

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

    CustomDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    CustomDomainName string
    Custom domain to associate with the workgroup.
    WorkgroupName string
    Name of the workgroup.
    CustomDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    CustomDomainName string
    Custom domain to associate with the workgroup.
    WorkgroupName string
    Name of the workgroup.
    customDomainCertificateArn String
    ARN of the certificate for the custom domain association.
    customDomainName String
    Custom domain to associate with the workgroup.
    workgroupName String
    Name of the workgroup.
    customDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    customDomainName string
    Custom domain to associate with the workgroup.
    workgroupName string
    Name of the workgroup.
    custom_domain_certificate_arn str
    ARN of the certificate for the custom domain association.
    custom_domain_name str
    Custom domain to associate with the workgroup.
    workgroup_name str
    Name of the workgroup.
    customDomainCertificateArn String
    ARN of the certificate for the custom domain association.
    customDomainName String
    Custom domain to associate with the workgroup.
    workgroupName String
    Name of the workgroup.

    Outputs

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

    CustomDomainCertificateExpiryTime string
    Expiration time for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    CustomDomainCertificateExpiryTime string
    Expiration time for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    customDomainCertificateExpiryTime String
    Expiration time for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    customDomainCertificateExpiryTime string
    Expiration time for the certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    custom_domain_certificate_expiry_time str
    Expiration time for the certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    customDomainCertificateExpiryTime String
    Expiration time for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomDomainAssociation Resource

    Get an existing CustomDomainAssociation 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?: CustomDomainAssociationState, opts?: CustomResourceOptions): CustomDomainAssociation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_domain_certificate_arn: Optional[str] = None,
        custom_domain_certificate_expiry_time: Optional[str] = None,
        custom_domain_name: Optional[str] = None,
        workgroup_name: Optional[str] = None) -> CustomDomainAssociation
    func GetCustomDomainAssociation(ctx *Context, name string, id IDInput, state *CustomDomainAssociationState, opts ...ResourceOption) (*CustomDomainAssociation, error)
    public static CustomDomainAssociation Get(string name, Input<string> id, CustomDomainAssociationState? state, CustomResourceOptions? opts = null)
    public static CustomDomainAssociation get(String name, Output<String> id, CustomDomainAssociationState 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:
    CustomDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    CustomDomainCertificateExpiryTime string
    Expiration time for the certificate.
    CustomDomainName string
    Custom domain to associate with the workgroup.
    WorkgroupName string
    Name of the workgroup.
    CustomDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    CustomDomainCertificateExpiryTime string
    Expiration time for the certificate.
    CustomDomainName string
    Custom domain to associate with the workgroup.
    WorkgroupName string
    Name of the workgroup.
    customDomainCertificateArn String
    ARN of the certificate for the custom domain association.
    customDomainCertificateExpiryTime String
    Expiration time for the certificate.
    customDomainName String
    Custom domain to associate with the workgroup.
    workgroupName String
    Name of the workgroup.
    customDomainCertificateArn string
    ARN of the certificate for the custom domain association.
    customDomainCertificateExpiryTime string
    Expiration time for the certificate.
    customDomainName string
    Custom domain to associate with the workgroup.
    workgroupName string
    Name of the workgroup.
    custom_domain_certificate_arn str
    ARN of the certificate for the custom domain association.
    custom_domain_certificate_expiry_time str
    Expiration time for the certificate.
    custom_domain_name str
    Custom domain to associate with the workgroup.
    workgroup_name str
    Name of the workgroup.
    customDomainCertificateArn String
    ARN of the certificate for the custom domain association.
    customDomainCertificateExpiryTime String
    Expiration time for the certificate.
    customDomainName String
    Custom domain to associate with the workgroup.
    workgroupName String
    Name of the workgroup.

    Import

    Using pulumi import, import Redshift Serverless Custom Domain Association using the workgroup_name and custom_domain_name, separated by the coma. For example:

    $ pulumi import aws:redshiftserverless/customDomainAssociation:CustomDomainAssociation example example-workgroup,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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws