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 the user pool domain associated with the hosted UI and OAuth endpoints.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services account that you created the user pool in.

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#cloud_front_distribution ⇒ String

The Amazon CloudFront endpoint that hosts your custom domain.

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config,
  :managed_login_version,
  :routing)
  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:



6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

class DomainDescriptionType < Struct.new(
  :user_pool_id,
  :aws_account_id,
  :domain,
  :s3_bucket,
  :cloud_front_distribution,
  :version,
  :status,
  :custom_domain_config,
  :managed_login_version,
  :routing)
  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) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#managed_login_version ⇒ Integer

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) branding and a version of 2 indicates managed login branding.

Managed login requires that your user pool be configured for any feature plan other than Lite.

Returns:

  • (Integer) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#routing ⇒ Types::RoutingType

The routing configuration for the domain, including failover settings for multi-region deployments. Currently only Failover configurations are allowed.

Returns:



6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#s3_bucket ⇒ String

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

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#status ⇒ String

The domain status.

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#user_pool_id ⇒ String

The ID of the user pool that the domain is attached to.

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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

#version ⇒ String

The app version.

Returns:

  • (String) 


6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6035

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