@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
121 lines (120 loc) • 5.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
/**
* The unique ID for an Amplify app.
*/
readonly appId: pulumi.Output<string>;
/**
* ARN for the Domain Association.
*/
readonly arn: pulumi.Output<string>;
/**
* Sets the branch patterns for automatic subdomain creation.
*/
readonly autoSubDomainCreationPatterns: pulumi.Output<string[] | undefined>;
/**
* The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
*/
readonly autoSubDomainIamRole: pulumi.Output<string | undefined>;
readonly certificate: pulumi.Output<outputs.amplify.DomainCertificate>;
/**
* DNS Record for certificate verification.
*/
readonly certificateRecord: pulumi.Output<string>;
/**
* The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
*/
readonly certificateSettings: pulumi.Output<outputs.amplify.DomainCertificateSettings | undefined>;
/**
* The domain name for the domain association.
*/
readonly domainName: pulumi.Output<string>;
/**
* Status for the Domain Association.
*/
readonly domainStatus: pulumi.Output<string>;
/**
* Enables the automated creation of subdomains for branches.
*/
readonly enableAutoSubDomain: pulumi.Output<boolean | undefined>;
/**
* Reason for the current status of the domain.
*/
readonly statusReason: pulumi.Output<string>;
/**
* The setting for the subdomain.
*/
readonly subDomainSettings: pulumi.Output<outputs.amplify.DomainSubDomainSetting[]>;
/**
* The status of the domain update operation that is currently in progress. The following list describes the valid update states.
*
* - **REQUESTING_CERTIFICATE** - The certificate is in the process of being updated.
* - **PENDING_VERIFICATION** - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
* - **IMPORTING_CUSTOM_CERTIFICATE** - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
* - **PENDING_DEPLOYMENT** - Indicates that the subdomain or certificate changes are being propagated.
* - **AWAITING_APP_CNAME** - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see [Setting up custom domains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User Guide* .
* - **UPDATE_COMPLETE** - The certificate has been associated with a domain.
* - **UPDATE_FAILED** - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
*/
readonly updateStatus: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
/**
* The unique ID for an Amplify app.
*/
appId: pulumi.Input<string>;
/**
* Sets the branch patterns for automatic subdomain creation.
*/
autoSubDomainCreationPatterns?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
*/
autoSubDomainIamRole?: pulumi.Input<string>;
/**
* The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
*/
certificateSettings?: pulumi.Input<inputs.amplify.DomainCertificateSettingsArgs>;
/**
* The domain name for the domain association.
*/
domainName?: pulumi.Input<string>;
/**
* Enables the automated creation of subdomains for branches.
*/
enableAutoSubDomain?: pulumi.Input<boolean>;
/**
* The setting for the subdomain.
*/
subDomainSettings: pulumi.Input<pulumi.Input<inputs.amplify.DomainSubDomainSettingArgs>[]>;
}