AWS Native is in preview. AWS Classic is fully supported.
aws-native.amplify.Domain
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
Create Domain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
args: DomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
sub_domain_settings: Optional[Sequence[DomainSubDomainSettingArgs]] = None,
auto_sub_domain_creation_patterns: Optional[Sequence[str]] = None,
auto_sub_domain_iam_role: Optional[str] = None,
certificate_settings: Optional[DomainCertificateSettingsArgs] = None,
domain_name: Optional[str] = None,
enable_auto_sub_domain: Optional[bool] = None)
func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: aws-native:amplify:Domain
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 DomainArgs
- 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 DomainArgs
- 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 DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const domainResource = new aws_native.amplify.Domain("domainResource", {
appId: "string",
subDomainSettings: [{
branchName: "string",
prefix: "string",
}],
autoSubDomainCreationPatterns: ["string"],
autoSubDomainIamRole: "string",
certificateSettings: {
certificateType: aws_native.amplify.DomainCertificateSettingsCertificateType.AmplifyManaged,
customCertificateArn: "string",
},
domainName: "string",
enableAutoSubDomain: false,
});
Coming soon!
Domain 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 Domain resource accepts the following input properties:
- app
Id String - sub
Domain List<DomainSettings Sub Domain Setting> - auto
Sub List<String>Domain Creation Patterns - auto
Sub StringDomain Iam Role - certificate
Settings DomainCertificate Settings - domain
Name String - enable
Auto BooleanSub Domain
- app
Id String - sub
Domain List<Property Map>Settings - auto
Sub List<String>Domain Creation Patterns - auto
Sub StringDomain Iam Role - certificate
Settings Property Map - domain
Name String - enable
Auto BooleanSub Domain
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Arn string
- Certificate
Pulumi.
Aws Native. Amplify. Outputs. Domain Certificate - Certificate
Record string - Domain
Status string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Reason string - Update
Status string
- Arn string
- Certificate
Domain
Certificate - Certificate
Record string - Domain
Status string - Id string
- The provider-assigned unique ID for this managed resource.
- Status
Reason string - Update
Status string
- arn String
- certificate
Domain
Certificate - certificate
Record String - domain
Status String - id String
- The provider-assigned unique ID for this managed resource.
- status
Reason String - update
Status String
- arn string
- certificate
Domain
Certificate - certificate
Record string - domain
Status string - id string
- The provider-assigned unique ID for this managed resource.
- status
Reason string - update
Status string
- arn str
- certificate
Domain
Certificate - certificate_
record str - domain_
status str - id str
- The provider-assigned unique ID for this managed resource.
- status_
reason str - update_
status str
- arn String
- certificate Property Map
- certificate
Record String - domain
Status String - id String
- The provider-assigned unique ID for this managed resource.
- status
Reason String - update
Status String
Supporting Types
DomainCertificate, DomainCertificateArgs
DomainCertificateCertificateType, DomainCertificateCertificateTypeArgs
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- Domain
Certificate Certificate Type Amplify Managed - AMPLIFY_MANAGED
- Domain
Certificate Certificate Type Custom - CUSTOM
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- AMPLIFY_MANAGED
- AMPLIFY_MANAGED
- CUSTOM
- CUSTOM
- "AMPLIFY_MANAGED"
- AMPLIFY_MANAGED
- "CUSTOM"
- CUSTOM
DomainCertificateSettings, DomainCertificateSettingsArgs
DomainCertificateSettingsCertificateType, DomainCertificateSettingsCertificateTypeArgs
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- Domain
Certificate Settings Certificate Type Amplify Managed - AMPLIFY_MANAGED
- Domain
Certificate Settings Certificate Type Custom - CUSTOM
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- Amplify
Managed - AMPLIFY_MANAGED
- Custom
- CUSTOM
- AMPLIFY_MANAGED
- AMPLIFY_MANAGED
- CUSTOM
- CUSTOM
- "AMPLIFY_MANAGED"
- AMPLIFY_MANAGED
- "CUSTOM"
- CUSTOM
DomainSubDomainSetting, DomainSubDomainSettingArgs
- Branch
Name string - Prefix string
- Branch
Name string - Prefix string
- branch
Name String - prefix String
- branch
Name string - prefix string
- branch_
name str - prefix str
- branch
Name String - prefix String
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.