Class: AWSCDK::Cognito::UserPoolDomain

Inherits:
Resource
  • Object
show all
Includes:
IUserPoolDomain
Defined in:
cognito/user_pool_domain.rb

Overview

Define a user pool domain.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ UserPoolDomain

Returns a new instance of UserPoolDomain.

Parameters:



12
13
14
15
16
17
18
 
# File 'cognito/user_pool_domain.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolDomainProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbERvbWFpblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_domain_name(scope, id, user_pool_domain_name) ⇒ AWSCDK::Cognito::IUserPoolDomain

Import a UserPoolDomain given its domain name.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • user_pool_domain_name (String)

Returns:



48
49
50
51
52
53
 
# File 'cognito/user_pool_domain.rb', line 48

def self.from_domain_name(scope, id, user_pool_domain_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(user_pool_domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolDomainName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolDomain", "fromDomainName", [scope, id, user_pool_domain_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'cognito/user_pool_domain.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :cloud_front_domain_name => { kind: :property, name: "cloudFrontDomainName", is_optional: false },
    :cloud_front_endpoint => { kind: :property, name: "cloudFrontEndpoint", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :user_pool_domain_ref => { kind: :property, name: "userPoolDomainRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :base_url => { kind: :method, name: "baseUrl", is_optional: false },
    :sign_in_url => { kind: :method, name: "signInUrl", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


101
102
103
 
# File 'cognito/user_pool_domain.rb', line 101

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolDomain", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



172
173
174
175
 
# File 'cognito/user_pool_domain.rb', line 172

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



189
190
191
192
 
# File 'cognito/user_pool_domain.rb', line 189

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#base_url(options = nil) ⇒ String

The URL to the hosted UI associated with this domain.

Parameters:

Returns:

  • (String) 


233
234
235
236
237
 
# File 'cognito/user_pool_domain.rb', line 233

def base_url(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::BaseURLOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5CYXNlVXJsT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("baseUrl", [options])
end

#cloud_front_domain_name ⇒ String

Deprecated.

use cloudFrontEndpoint method instead.

The domain name of the CloudFront distribution associated with the user pool domain.

This method creates a custom resource internally to get the CloudFront domain name.

Returns:

  • (String) 


111
112
113
 
# File 'cognito/user_pool_domain.rb', line 111

def cloud_front_domain_name()
  jsii_get_property("cloudFrontDomainName")
end

#cloud_front_endpoint ⇒ String

The domain name of the CloudFront distribution associated with the user pool domain.

Returns:

  • (String) 


118
119
120
 
# File 'cognito/user_pool_domain.rb', line 118

def cloud_front_endpoint()
  jsii_get_property("cloudFrontEndpoint")
end

#domain_name ⇒ String

The domain that was specified to be created.

If custom_domain was selected, this holds the full domain name that was specified. If the cognito_domain was used, it contains the prefix to the Cognito hosted domain.

Returns:

  • (String) 


128
129
130
 
# File 'cognito/user_pool_domain.rb', line 128

def domain_name()
  jsii_get_property("domainName")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



73
74
75
 
# File 'cognito/user_pool_domain.rb', line 73

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


195
196
197
 
# File 'cognito/user_pool_domain.rb', line 195

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


209
210
211
212
213
214
 
# File 'cognito/user_pool_domain.rb', line 209

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


224
225
226
227
 
# File 'cognito/user_pool_domain.rb', line 224

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


58
59
60
 
# File 'cognito/user_pool_domain.rb', line 58

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


87
88
89
 
# File 'cognito/user_pool_domain.rb', line 87

def physical_name()
  jsii_get_property("physicalName")
end

#sign_in_url(client, options) ⇒ String

The URL to the sign in page in this domain using a specific UserPoolClient.

Parameters:

Returns:

  • (String) 


244
245
246
247
248
249
 
# File 'cognito/user_pool_domain.rb', line 244

def (client, options)
  Jsii::Type.check_type(client, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbENsaWVudCJ9")), "client")
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::SignInURLOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TaWduSW5VcmxPcHRpb25zIn0=")), "options")
  jsii_call_method("signInUrl", [client, options])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



94
95
96
 
# File 'cognito/user_pool_domain.rb', line 94

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


142
143
144
 
# File 'cognito/user_pool_domain.rb', line 142

def to_string()
  jsii_call_method("toString", [])
end

#user_pool_domain_ref ⇒ AWSCDK::Interfaces::AWSCognito::UserPoolDomainReference

A reference to a UserPoolDomain resource.

Returns:



135
136
137
 
# File 'cognito/user_pool_domain.rb', line 135

def user_pool_domain_ref()
  jsii_get_property("userPoolDomainRef")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


155
156
157
158
159
160
 
# File 'cognito/user_pool_domain.rb', line 155

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end