Class: AWSCDK::Cognito::UserPoolClient

Inherits:
Resource
  • Object
show all
Includes:
IUserPoolClient
Defined in:
cognito/user_pool_client.rb

Overview

Define a UserPool App Client.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ UserPoolClient

Returns a new instance of UserPoolClient.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolClientProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbENsaWVudFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_user_pool_client_id(scope, id, user_pool_client_id) ⇒ AWSCDK::Cognito::IUserPoolClient

Import a user pool client given its id.

Parameters:

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

Returns:



47
48
49
50
51
52
 
# File 'cognito/user_pool_client.rb', line 47

def self.from_user_pool_client_id(scope, id, user_pool_client_id)
  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_client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolClientId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolClient", "fromUserPoolClientId", [scope, id, user_pool_client_id])
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
 
# File 'cognito/user_pool_client.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 },
    :o_auth_flows => { kind: :property, name: "oAuthFlows", is_optional: false },
    :user_pool_client_id => { kind: :property, name: "userPoolClientId", is_optional: false },
    :user_pool_client_name => { kind: :property, name: "userPoolClientName", is_optional: false },
    :user_pool_client_ref => { kind: :property, name: "userPoolClientRef", is_optional: false },
    :user_pool_client_secret => { kind: :property, name: "userPoolClientSecret", 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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


100
101
102
 
# File 'cognito/user_pool_client.rb', line 100

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClient", "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:



174
175
176
177
 
# File 'cognito/user_pool_client.rb', line 174

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:



191
192
193
194
 
# File 'cognito/user_pool_client.rb', line 191

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



72
73
74
 
# File 'cognito/user_pool_client.rb', line 72

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


197
198
199
 
# File 'cognito/user_pool_client.rb', line 197

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) 


211
212
213
214
215
216
 
# File 'cognito/user_pool_client.rb', line 211

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) 


226
227
228
229
 
# File 'cognito/user_pool_client.rb', line 226

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) 


57
58
59
 
# File 'cognito/user_pool_client.rb', line 57

def node()
  jsii_get_property("node")
end

#o_auth_flows ⇒ AWSCDK::Cognito::OAuthFlows

The OAuth flows enabled for this client.

Returns:



107
108
109
 
# File 'cognito/user_pool_client.rb', line 107

def o_auth_flows()
  jsii_get_property("oAuthFlows")
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) 


86
87
88
 
# File 'cognito/user_pool_client.rb', line 86

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



93
94
95
 
# File 'cognito/user_pool_client.rb', line 93

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


144
145
146
 
# File 'cognito/user_pool_client.rb', line 144

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

#user_pool_client_id ⇒ String

Name of the application client.

Returns:

  • (String) 


114
115
116
 
# File 'cognito/user_pool_client.rb', line 114

def user_pool_client_id()
  jsii_get_property("userPoolClientId")
end

#user_pool_client_name ⇒ String

The client name that was specified via the userPoolClientName property during initialization, throws an error otherwise.

Returns:

  • (String) 


121
122
123
 
# File 'cognito/user_pool_client.rb', line 121

def user_pool_client_name()
  jsii_get_property("userPoolClientName")
end

#user_pool_client_ref ⇒ AWSCDK::Interfaces::AWSCognito::UserPoolClientReference

A reference to a UserPoolClient resource.

Returns:



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

def user_pool_client_ref()
  jsii_get_property("userPoolClientRef")
end

#user_pool_client_secret ⇒ AWSCDK::SecretValue

The generated client secret.

Only available if the "generateSecret" props is set to true

Returns:



137
138
139
 
# File 'cognito/user_pool_client.rb', line 137

def user_pool_client_secret()
  jsii_get_property("userPoolClientSecret")
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) 


157
158
159
160
161
162
 
# File 'cognito/user_pool_client.rb', line 157

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