1. Packages
  2. AWS Native
  3. API Docs
  4. amplify
  5. Domain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.amplify.Domain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.

    Create Domain Resource

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               app_id: Optional[str] = None,
               auto_sub_domain_creation_patterns: Optional[Sequence[str]] = None,
               auto_sub_domain_iam_role: Optional[str] = None,
               certificate: Optional[DomainCertificateArgs] = None,
               certificate_settings: Optional[DomainCertificateSettingsArgs] = None,
               domain_name: Optional[str] = None,
               enable_auto_sub_domain: Optional[bool] = None,
               sub_domain_settings: Optional[Sequence[DomainSubDomainSettingArgs]] = None,
               update_status: Optional[str] = None)
    @overload
    def Domain(resource_name: str,
               args: DomainArgs,
               opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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:

    Outputs

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

    Arn string
    CertificateRecord string
    DomainStatus string
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusReason string
    Arn string
    CertificateRecord string
    DomainStatus string
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusReason string
    arn String
    certificateRecord String
    domainStatus String
    id String
    The provider-assigned unique ID for this managed resource.
    statusReason String
    arn string
    certificateRecord string
    domainStatus string
    id string
    The provider-assigned unique ID for this managed resource.
    statusReason string
    arn str
    certificate_record str
    domain_status str
    id str
    The provider-assigned unique ID for this managed resource.
    status_reason str
    arn String
    certificateRecord String
    domainStatus String
    id String
    The provider-assigned unique ID for this managed resource.
    statusReason String

    Supporting Types

    DomainCertificate, DomainCertificateArgs

    DomainCertificateCertificateType, DomainCertificateCertificateTypeArgs

    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    DomainCertificateCertificateTypeAmplifyManaged
    AMPLIFY_MANAGED
    DomainCertificateCertificateTypeCustom
    CUSTOM
    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    AMPLIFY_MANAGED
    AMPLIFY_MANAGED
    CUSTOM
    CUSTOM
    "AMPLIFY_MANAGED"
    AMPLIFY_MANAGED
    "CUSTOM"
    CUSTOM

    DomainCertificateSettings, DomainCertificateSettingsArgs

    DomainCertificateSettingsCertificateType, DomainCertificateSettingsCertificateTypeArgs

    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    DomainCertificateSettingsCertificateTypeAmplifyManaged
    AMPLIFY_MANAGED
    DomainCertificateSettingsCertificateTypeCustom
    CUSTOM
    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    AmplifyManaged
    AMPLIFY_MANAGED
    Custom
    CUSTOM
    AMPLIFY_MANAGED
    AMPLIFY_MANAGED
    CUSTOM
    CUSTOM
    "AMPLIFY_MANAGED"
    AMPLIFY_MANAGED
    "CUSTOM"
    CUSTOM

    DomainSubDomainSetting, DomainSubDomainSettingArgs

    BranchName string
    Prefix string
    BranchName string
    Prefix string
    branchName String
    prefix String
    branchName string
    prefix string
    branchName String
    prefix String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi