Module: AWSCDK::Cognito::IUserPoolDomain

Includes:
IResource, Interfaces::AWSCognito::IUserPoolDomainRef
Included in:
UserPoolDomain
Defined in:
cognito/i_user_pool_domain.rb

Overview

Represents a user pool domain.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
 
# File 'cognito/i_user_pool_domain.rb', line 86

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :user_pool_domain_ref => { kind: :property, name: "userPoolDomainRef", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#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:



81
82
83
84
 
# File 'cognito/i_user_pool_domain.rb', line 81

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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) 


51
52
53
 
# File 'cognito/i_user_pool_domain.rb', line 51

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:



27
28
29
 
# File 'cognito/i_user_pool_domain.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'cognito/i_user_pool_domain.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'cognito/i_user_pool_domain.rb', line 34

def stack()
  jsii_get_property("stack")
end

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

A reference to a UserPoolDomain resource.

Returns:



41
42
43
 
# File 'cognito/i_user_pool_domain.rb', line 41

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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



62
63
64
65
66
67
 
# File 'cognito/i_user_pool_domain.rb', line 62

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