You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Amplify::Types::CreateDomainAssociationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDomainAssociationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  app_id: "AppId", # required
  domain_name: "DomainName", # required
  enable_auto_sub_domain: false,
  sub_domain_settings: [ # required
    {
      prefix: "DomainPrefix", # required
      branch_name: "BranchName", # required
    },
  ],
  auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
  auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
}

The request structure for the create domain association request.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) —

    The unique ID for an Amplify app.

#auto_sub_domain_creation_patterns ⇒ Array<String>

Sets the branch patterns for automatic subdomain creation.

Returns:

  • (Array<String>) —

    Sets the branch patterns for automatic subdomain creation.

#auto_sub_domain_iam_role ⇒ String

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Returns:

  • (String) —

    The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

#domain_name ⇒ String

The domain name for the domain association.

Returns:

  • (String) —

    The domain name for the domain association.

#enable_auto_sub_domain ⇒ Boolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean) —

    Enables the automated creation of subdomains for branches.

#sub_domain_settings ⇒ Array<Types::SubDomainSetting>

The setting for the subdomain.

Returns: