AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::Amplify::Types::UpdateDomainAssociationRequest

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

Overview

Note:

When passing UpdateDomainAssociationRequest 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 update domain association request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)

    The unique ID for an Amplify app.

#auto_sub_domain_creation_patternsArray<String>

Sets the branch patterns for automatic subdomain creation.

Returns:

  • (Array<String>)

    Sets the branch patterns for automatic subdomain creation.

#auto_sub_domain_iam_roleString

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_nameString

The name of the domain.

Returns:

  • (String)

    The name of the domain.

#enable_auto_sub_domainBoolean

Enables the automated creation of subdomains for branches.

Returns:

  • (Boolean)

    Enables the automated creation of subdomains for branches.

#sub_domain_settingsArray<Types::SubDomainSetting>

Describes the settings for the subdomain.

Returns: