Class: AWSCDK::Cognito::CfnUserPoolClient

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSCognito::IUserPoolClientRef
Defined in:
cognito/cfn_user_pool_client.rb

Overview

The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnUserPoolClient

Create a new AWS::Cognito::UserPoolClient.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Cognito::CfnUserPoolClientProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'cognito/cfn_user_pool_client.rb', line 19

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'cognito/cfn_user_pool_client.rb', line 196

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

.is_cfn_user_pool_client(x) ⇒ Boolean

Checks whether the given object is a CfnUserPoolClient.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'cognito/cfn_user_pool_client.rb', line 98

def self.is_cfn_user_pool_client(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnUserPoolClient", "isCfnUserPoolClient", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'cognito/cfn_user_pool_client.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_client_id => { kind: :property, name: "attrClientId", is_optional: false },
    :attr_client_secret => { kind: :property, name: "attrClientSecret", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :user_pool_client_ref => { kind: :property, name: "userPoolClientRef", is_optional: false },
    :user_pool_id => { kind: :property, name: "userPoolId", is_optional: false },
    :access_token_validity => { kind: :property, name: "accessTokenValidity", is_optional: true },
    :allowed_o_auth_flows => { kind: :property, name: "allowedOAuthFlows", is_optional: true },
    :allowed_o_auth_flows_user_pool_client => { kind: :property, name: "allowedOAuthFlowsUserPoolClient", is_optional: true },
    :allowed_o_auth_scopes => { kind: :property, name: "allowedOAuthScopes", is_optional: true },
    :analytics_configuration => { kind: :property, name: "analyticsConfiguration", is_optional: true },
    :auth_session_validity => { kind: :property, name: "authSessionValidity", is_optional: true },
    :callback_ur_ls => { kind: :property, name: "callbackUrLs", is_optional: true },
    :client_name => { kind: :property, name: "clientName", is_optional: true },
    :default_redirect_uri => { kind: :property, name: "defaultRedirectUri", is_optional: true },
    :enable_propagate_additional_user_context_data => { kind: :property, name: "enablePropagateAdditionalUserContextData", is_optional: true },
    :enable_token_revocation => { kind: :property, name: "enableTokenRevocation", is_optional: true },
    :explicit_auth_flows => { kind: :property, name: "explicitAuthFlows", is_optional: true },
    :generate_secret => { kind: :property, name: "generateSecret", is_optional: true },
    :id_token_validity => { kind: :property, name: "idTokenValidity", is_optional: true },
    :logout_ur_ls => { kind: :property, name: "logoutUrLs", is_optional: true },
    :prevent_user_existence_errors => { kind: :property, name: "preventUserExistenceErrors", is_optional: true },
    :read_attributes => { kind: :property, name: "readAttributes", is_optional: true },
    :refresh_token_rotation => { kind: :property, name: "refreshTokenRotation", is_optional: true },
    :refresh_token_validity => { kind: :property, name: "refreshTokenValidity", is_optional: true },
    :supported_identity_providers => { kind: :property, name: "supportedIdentityProviders", is_optional: true },
    :token_validity_units => { kind: :property, name: "tokenValidityUnits", is_optional: true },
    :write_attributes => { kind: :property, name: "writeAttributes", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#access_token_validity ⇒ Numeric?

The access token time limit.

Returns:

  • (Numeric, nil) 


239
240
241
 
# File 'cognito/cfn_user_pool_client.rb', line 239

def access_token_validity()
  jsii_get_property("accessTokenValidity")
end

#access_token_validity=(value) ⇒ Object 



243
244
245
246
 
# File 'cognito/cfn_user_pool_client.rb', line 243

def access_token_validity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "accessTokenValidity") unless value.nil?
  jsii_set_property("accessTokenValidity", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



539
540
541
542
 
# File 'cognito/cfn_user_pool_client.rb', line 539

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



551
552
553
554
 
# File 'cognito/cfn_user_pool_client.rb', line 551

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



561
562
563
564
 
# File 'cognito/cfn_user_pool_client.rb', line 561

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



572
573
574
575
576
 
# File 'cognito/cfn_user_pool_client.rb', line 572

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


629
630
631
632
633
 
# File 'cognito/cfn_user_pool_client.rb', line 629

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



639
640
641
642
 
# File 'cognito/cfn_user_pool_client.rb', line 639

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



651
652
653
654
655
 
# File 'cognito/cfn_user_pool_client.rb', line 651

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#allowed_o_auth_flows ⇒ Array<String>?

The OAuth grant types that you want your app client to generate for clients in managed login authentication.

Returns:

  • (Array<String>, nil) 


251
252
253
 
# File 'cognito/cfn_user_pool_client.rb', line 251

def allowed_o_auth_flows()
  jsii_get_property("allowedOAuthFlows")
end

#allowed_o_auth_flows=(value) ⇒ Object 



255
256
257
258
 
# File 'cognito/cfn_user_pool_client.rb', line 255

def allowed_o_auth_flows=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedOAuthFlows") unless value.nil?
  jsii_set_property("allowedOAuthFlows", value)
end

#allowed_o_auth_flows_user_pool_client ⇒ Boolean, ...

Set to true to use OAuth 2.0 authorization server features in your app client.

Returns:



263
264
265
 
# File 'cognito/cfn_user_pool_client.rb', line 263

def allowed_o_auth_flows_user_pool_client()
  jsii_get_property("allowedOAuthFlowsUserPoolClient")
end

#allowed_o_auth_flows_user_pool_client=(value) ⇒ Object 



267
268
269
270
 
# File 'cognito/cfn_user_pool_client.rb', line 267

def allowed_o_auth_flows_user_pool_client=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowedOAuthFlowsUserPoolClient") unless value.nil?
  jsii_set_property("allowedOAuthFlowsUserPoolClient", value)
end

#allowed_o_auth_scopes ⇒ Array<String>?

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.

Returns:

  • (Array<String>, nil) 


275
276
277
 
# File 'cognito/cfn_user_pool_client.rb', line 275

def allowed_o_auth_scopes()
  jsii_get_property("allowedOAuthScopes")
end

#allowed_o_auth_scopes=(value) ⇒ Object 



279
280
281
282
 
# File 'cognito/cfn_user_pool_client.rb', line 279

def allowed_o_auth_scopes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedOAuthScopes") unless value.nil?
  jsii_set_property("allowedOAuthScopes", value)
end

#analytics_configuration ⇒ AWSCDK::IResolvable, ...

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

Returns:



287
288
289
 
# File 'cognito/cfn_user_pool_client.rb', line 287

def analytics_configuration()
  jsii_get_property("analyticsConfiguration")
end

#analytics_configuration=(value) ⇒ Object 



291
292
293
294
295
 
# File 'cognito/cfn_user_pool_client.rb', line 291

def analytics_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::AnalyticsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LkFuYWx5dGljc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "analyticsConfiguration") unless value.nil?
  jsii_set_property("analyticsConfiguration", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



664
665
666
667
 
# File 'cognito/cfn_user_pool_client.rb', line 664

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



686
687
688
689
690
691
 
# File 'cognito/cfn_user_pool_client.rb', line 686

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_client_id ⇒ String

The ID of the app client, for example 1example23456789 .

Returns:

  • (String) 


203
204
205
 
# File 'cognito/cfn_user_pool_client.rb', line 203

def attr_client_id()
  jsii_get_property("attrClientId")
end

#attr_client_secret ⇒ String

Returns:

  • (String) 


208
209
210
 
# File 'cognito/cfn_user_pool_client.rb', line 208

def attr_client_secret()
  jsii_get_property("attrClientSecret")
end

#attr_name ⇒ String

Returns:

  • (String) 


213
214
215
 
# File 'cognito/cfn_user_pool_client.rb', line 213

def attr_name()
  jsii_get_property("attrName")
end

#auth_session_validity ⇒ Numeric?

Amazon Cognito creates a session token for each API request in an authentication flow.

Returns:

  • (Numeric, nil) 


300
301
302
 
# File 'cognito/cfn_user_pool_client.rb', line 300

def auth_session_validity()
  jsii_get_property("authSessionValidity")
end

#auth_session_validity=(value) ⇒ Object 



304
305
306
307
 
# File 'cognito/cfn_user_pool_client.rb', line 304

def auth_session_validity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "authSessionValidity") unless value.nil?
  jsii_set_property("authSessionValidity", value)
end

#callback_ur_ls ⇒ Array<String>?

A list of allowed redirect, or callback, URLs for managed login authentication.

Returns:

  • (Array<String>, nil) 


312
313
314
 
# File 'cognito/cfn_user_pool_client.rb', line 312

def callback_ur_ls()
  jsii_get_property("callbackUrLs")
end

#callback_ur_ls=(value) ⇒ Object 



316
317
318
319
 
# File 'cognito/cfn_user_pool_client.rb', line 316

def callback_ur_ls=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "callbackUrLs") unless value.nil?
  jsii_set_property("callbackUrLs", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



149
150
151
 
# File 'cognito/cfn_user_pool_client.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'cognito/cfn_user_pool_client.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


695
696
697
698
 
# File 'cognito/cfn_user_pool_client.rb', line 695

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


159
160
161
 
# File 'cognito/cfn_user_pool_client.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'cognito/cfn_user_pool_client.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_name ⇒ String?

A friendly name for the app client that you want to create.

Returns:

  • (String, nil) 


324
325
326
 
# File 'cognito/cfn_user_pool_client.rb', line 324

def client_name()
  jsii_get_property("clientName")
end

#client_name=(value) ⇒ Object 



328
329
330
331
 
# File 'cognito/cfn_user_pool_client.rb', line 328

def client_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientName") unless value.nil?
  jsii_set_property("clientName", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#default_redirect_uri ⇒ String?

The default redirect URI.

Returns:

  • (String, nil) 


336
337
338
 
# File 'cognito/cfn_user_pool_client.rb', line 336

def default_redirect_uri()
  jsii_get_property("defaultRedirectUri")
end

#default_redirect_uri=(value) ⇒ Object 



340
341
342
343
 
# File 'cognito/cfn_user_pool_client.rb', line 340

def default_redirect_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultRedirectUri") unless value.nil?
  jsii_set_property("defaultRedirectUri", value)
end

#enable_propagate_additional_user_context_data ⇒ Boolean, ...

When true , your application can include additional UserContextData in authentication requests.

Returns:



348
349
350
 
# File 'cognito/cfn_user_pool_client.rb', line 348

def enable_propagate_additional_user_context_data()
  jsii_get_property("enablePropagateAdditionalUserContextData")
end

#enable_propagate_additional_user_context_data=(value) ⇒ Object 



352
353
354
355
 
# File 'cognito/cfn_user_pool_client.rb', line 352

def enable_propagate_additional_user_context_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enablePropagateAdditionalUserContextData") unless value.nil?
  jsii_set_property("enablePropagateAdditionalUserContextData", value)
end

#enable_token_revocation ⇒ Boolean, ...

Activates or deactivates token revocation.

Returns:



360
361
362
 
# File 'cognito/cfn_user_pool_client.rb', line 360

def enable_token_revocation()
  jsii_get_property("enableTokenRevocation")
end

#enable_token_revocation=(value) ⇒ Object 



364
365
366
367
 
# File 'cognito/cfn_user_pool_client.rb', line 364

def enable_token_revocation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableTokenRevocation") unless value.nil?
  jsii_set_property("enableTokenRevocation", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'cognito/cfn_user_pool_client.rb', line 171

def env()
  jsii_get_property("env")
end

#explicit_auth_flows ⇒ Array<String>?

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

Returns:

  • (Array<String>, nil) 


372
373
374
 
# File 'cognito/cfn_user_pool_client.rb', line 372

def explicit_auth_flows()
  jsii_get_property("explicitAuthFlows")
end

#explicit_auth_flows=(value) ⇒ Object 



376
377
378
379
 
# File 'cognito/cfn_user_pool_client.rb', line 376

def explicit_auth_flows=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "explicitAuthFlows") unless value.nil?
  jsii_set_property("explicitAuthFlows", value)
end

#generate_secret ⇒ Boolean, ...

When true , generates a client secret for the app client.

Returns:



384
385
386
 
# File 'cognito/cfn_user_pool_client.rb', line 384

def generate_secret()
  jsii_get_property("generateSecret")
end

#generate_secret=(value) ⇒ Object 



388
389
390
391
 
# File 'cognito/cfn_user_pool_client.rb', line 388

def generate_secret=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "generateSecret") unless value.nil?
  jsii_set_property("generateSecret", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



708
709
710
711
712
 
# File 'cognito/cfn_user_pool_client.rb', line 708

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



719
720
721
722
 
# File 'cognito/cfn_user_pool_client.rb', line 719

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#id_token_validity ⇒ Numeric?

The ID token time limit.

Returns:

  • (Numeric, nil) 


396
397
398
 
# File 'cognito/cfn_user_pool_client.rb', line 396

def id_token_validity()
  jsii_get_property("idTokenValidity")
end

#id_token_validity=(value) ⇒ Object 



400
401
402
403
 
# File 'cognito/cfn_user_pool_client.rb', line 400

def id_token_validity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idTokenValidity") unless value.nil?
  jsii_set_property("idTokenValidity", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



789
790
791
792
 
# File 'cognito/cfn_user_pool_client.rb', line 789

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


123
124
125
 
# File 'cognito/cfn_user_pool_client.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#logout_ur_ls ⇒ Array<String>?

A list of allowed logout URLs for managed login authentication.

Returns:

  • (Array<String>, nil) 


408
409
410
 
# File 'cognito/cfn_user_pool_client.rb', line 408

def logout_ur_ls()
  jsii_get_property("logoutUrLs")
end

#logout_ur_ls=(value) ⇒ Object 



412
413
414
415
 
# File 'cognito/cfn_user_pool_client.rb', line 412

def logout_ur_ls=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logoutUrLs") unless value.nil?
  jsii_set_property("logoutUrLs", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'cognito/cfn_user_pool_client.rb', line 106

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



730
731
732
 
# File 'cognito/cfn_user_pool_client.rb', line 730

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



737
738
739
 
# File 'cognito/cfn_user_pool_client.rb', line 737

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



530
531
532
533
 
# File 'cognito/cfn_user_pool_client.rb', line 530

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#prevent_user_existence_errors ⇒ String?

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.

Returns:

  • (String, nil) 


420
421
422
 
# File 'cognito/cfn_user_pool_client.rb', line 420

def prevent_user_existence_errors()
  jsii_get_property("preventUserExistenceErrors")
end

#prevent_user_existence_errors=(value) ⇒ Object 



424
425
426
427
 
# File 'cognito/cfn_user_pool_client.rb', line 424

def prevent_user_existence_errors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preventUserExistenceErrors") unless value.nil?
  jsii_set_property("preventUserExistenceErrors", value)
end

#read_attributes ⇒ Array<String>?

The list of user attributes that you want your app client to have read access to.

Returns:

  • (Array<String>, nil) 


432
433
434
 
# File 'cognito/cfn_user_pool_client.rb', line 432

def read_attributes()
  jsii_get_property("readAttributes")
end

#read_attributes=(value) ⇒ Object 



436
437
438
439
 
# File 'cognito/cfn_user_pool_client.rb', line 436

def read_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "readAttributes") unless value.nil?
  jsii_set_property("readAttributes", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


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

def ref()
  jsii_get_property("ref")
end

#refresh_token_rotation ⇒ AWSCDK::IResolvable, ...

The configuration of your app client for refresh token rotation.

Returns:



444
445
446
 
# File 'cognito/cfn_user_pool_client.rb', line 444

def refresh_token_rotation()
  jsii_get_property("refreshTokenRotation")
end

#refresh_token_rotation=(value) ⇒ Object 



448
449
450
451
452
 
# File 'cognito/cfn_user_pool_client.rb', line 448

def refresh_token_rotation=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::RefreshTokenRotationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LlJlZnJlc2hUb2tlblJvdGF0aW9uUHJvcGVydHkifV19fQ==")), "refreshTokenRotation") unless value.nil?
  jsii_set_property("refreshTokenRotation", value)
end

#refresh_token_validity ⇒ Numeric?

The refresh token time limit.

Returns:

  • (Numeric, nil) 


457
458
459
 
# File 'cognito/cfn_user_pool_client.rb', line 457

def refresh_token_validity()
  jsii_get_property("refreshTokenValidity")
end

#refresh_token_validity=(value) ⇒ Object 



461
462
463
464
 
# File 'cognito/cfn_user_pool_client.rb', line 461

def refresh_token_validity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "refreshTokenValidity") unless value.nil?
  jsii_set_property("refreshTokenValidity", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



748
749
750
751
 
# File 'cognito/cfn_user_pool_client.rb', line 748

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


755
756
757
758
 
# File 'cognito/cfn_user_pool_client.rb', line 755

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



765
766
767
768
769
 
# File 'cognito/cfn_user_pool_client.rb', line 765

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



774
775
776
 
# File 'cognito/cfn_user_pool_client.rb', line 774

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



132
133
134
 
# File 'cognito/cfn_user_pool_client.rb', line 132

def stack()
  jsii_get_property("stack")
end

#supported_identity_providers ⇒ Array<String>?

A list of provider names for the identity providers (IdPs) that are supported on this client.

Returns:

  • (Array<String>, nil) 


469
470
471
 
# File 'cognito/cfn_user_pool_client.rb', line 469

def supported_identity_providers()
  jsii_get_property("supportedIdentityProviders")
end

#supported_identity_providers=(value) ⇒ Object 



473
474
475
476
 
# File 'cognito/cfn_user_pool_client.rb', line 473

def supported_identity_providers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "supportedIdentityProviders") unless value.nil?
  jsii_set_property("supportedIdentityProviders", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



506
507
508
 
# File 'cognito/cfn_user_pool_client.rb', line 506

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

#token_validity_units ⇒ AWSCDK::IResolvable, ...

The units that validity times are represented in.

Returns:



481
482
483
 
# File 'cognito/cfn_user_pool_client.rb', line 481

def token_validity_units()
  jsii_get_property("tokenValidityUnits")
end

#token_validity_units=(value) ⇒ Object 



485
486
487
488
489
 
# File 'cognito/cfn_user_pool_client.rb', line 485

def token_validity_units=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::TokenValidityUnitsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LlRva2VuVmFsaWRpdHlVbml0c1Byb3BlcnR5In1dfX0=")), "tokenValidityUnits") unless value.nil?
  jsii_set_property("tokenValidityUnits", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'cognito/cfn_user_pool_client.rb', line 179

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

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

A reference to a UserPoolClient resource.

Returns:



220
221
222
 
# File 'cognito/cfn_user_pool_client.rb', line 220

def user_pool_client_ref()
  jsii_get_property("userPoolClientRef")
end

#user_pool_id ⇒ String

The ID of the user pool where you want to create an app client.

Returns:

  • (String) 


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

def user_pool_id()
  jsii_get_property("userPoolId")
end

#user_pool_id=(value) ⇒ Object 



231
232
233
234
 
# File 'cognito/cfn_user_pool_client.rb', line 231

def user_pool_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  jsii_set_property("userPoolId", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


780
781
782
783
 
# File 'cognito/cfn_user_pool_client.rb', line 780

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


519
520
521
522
523
524
 
# File 'cognito/cfn_user_pool_client.rb', line 519

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

#write_attributes ⇒ Array<String>?

The list of user attributes that you want your app client to have write access to.

Returns:

  • (Array<String>, nil) 


494
495
496
 
# File 'cognito/cfn_user_pool_client.rb', line 494

def write_attributes()
  jsii_get_property("writeAttributes")
end

#write_attributes=(value) ⇒ Object 



498
499
500
501
 
# File 'cognito/cfn_user_pool_client.rb', line 498

def write_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "writeAttributes") unless value.nil?
  jsii_set_property("writeAttributes", value)
end