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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services ID for the user pool owner.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#cloud_front_distribution ⇒ String

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#custom_domain_config ⇒ Types::CustomDomainConfigType

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

Returns:



4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#domain ⇒ String

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#s3_bucket ⇒ String

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

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#status ⇒ String

The domain status.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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

#version ⇒ String

The app version.

Returns:

  • (String) 


4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4305

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