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

Class: Aws::CognitoIdentityProvider::Types::DomainDescriptionType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A container for information about a domain.

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The AWS account ID for the user pool owner.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#cloud_front_distributionString

The ARN of the CloudFront distribution.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#custom_domain_configTypes::CustomDomainConfigType

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.



3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#domainString

The domain string.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#s3_bucketString

The S3 bucket where the static files for this domain are stored.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#statusString

The domain status.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end

#versionString

The app version.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3755

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config)
  include Aws::Structure
end