CfnUserPoolClient

class aws_cdk.aws_cognito.CfnUserPoolClient(scope, id, *, user_pool_id, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, explicit_auth_flows=None, generate_secret=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, write_attributes=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Cognito::UserPoolClient.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html cloudformationResource: :cloudformationResource:: AWS::Cognito::UserPoolClient

__init__(scope, id, *, user_pool_id, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, explicit_auth_flows=None, generate_secret=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, write_attributes=None)

Create a new AWS::Cognito::UserPoolClient.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • user_pool_id (str) – AWS::Cognito::UserPoolClient.UserPoolId.

  • allowed_o_auth_flows (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlows.

  • allowed_o_auth_flows_user_pool_client (Union[bool, None, IResolvable]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient.

  • allowed_o_auth_scopes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthScopes.

  • analytics_configuration (Union[IResolvable, None, Forwardref]) – AWS::Cognito::UserPoolClient.AnalyticsConfiguration.

  • callback_ur_ls (Optional[List[str]]) – AWS::Cognito::UserPoolClient.CallbackURLs.

  • client_name (Optional[str]) – AWS::Cognito::UserPoolClient.ClientName.

  • default_redirect_uri (Optional[str]) – AWS::Cognito::UserPoolClient.DefaultRedirectURI.

  • explicit_auth_flows (Optional[List[str]]) – AWS::Cognito::UserPoolClient.ExplicitAuthFlows.

  • generate_secret (Union[bool, None, IResolvable]) – AWS::Cognito::UserPoolClient.GenerateSecret.

  • logout_ur_ls (Optional[List[str]]) – AWS::Cognito::UserPoolClient.LogoutURLs.

  • prevent_user_existence_errors (Optional[str]) – AWS::Cognito::UserPoolClient.PreventUserExistenceErrors.

  • read_attributes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.ReadAttributes.

  • refresh_token_validity (Union[int, float, None]) – AWS::Cognito::UserPoolClient.RefreshTokenValidity.

  • supported_identity_providers (Optional[List[str]]) – AWS::Cognito::UserPoolClient.SupportedIdentityProviders.

  • write_attributes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.WriteAttributes.

Return type

None

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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

target (CfnResource) –

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride 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.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

stability :stability: experimental

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

return :rtype: str :return: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Cognito::UserPoolClient'
allowed_o_auth_flows

AWS::Cognito::UserPoolClient.AllowedOAuthFlows.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows

Return type

Optional[List[str]]

allowed_o_auth_flows_user_pool_client

AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient

Return type

Union[bool, None, IResolvable]

allowed_o_auth_scopes

AWS::Cognito::UserPoolClient.AllowedOAuthScopes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes

Return type

Optional[List[str]]

analytics_configuration

AWS::Cognito::UserPoolClient.AnalyticsConfiguration.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration

Return type

Union[IResolvable, None, Forwardref]

attr_client_secret

cloudformationAttribute: :cloudformationAttribute:: ClientSecret

Return type

str

attr_name

cloudformationAttribute: :cloudformationAttribute:: Name

Return type

str

callback_ur_ls

AWS::Cognito::UserPoolClient.CallbackURLs.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-callbackurls

Return type

Optional[List[str]]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

client_name

AWS::Cognito::UserPoolClient.ClientName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname

Return type

Optional[str]

creation_stack

return :rtype: List[str] :return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

default_redirect_uri

AWS::Cognito::UserPoolClient.DefaultRedirectURI.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-defaultredirecturi

Return type

Optional[str]

explicit_auth_flows

AWS::Cognito::UserPoolClient.ExplicitAuthFlows.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows

Return type

Optional[List[str]]

generate_secret

AWS::Cognito::UserPoolClient.GenerateSecret.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret

Return type

Union[bool, None, IResolvable]

logical_id

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 overrideLogicalId(newLogicalId).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

logout_ur_ls

AWS::Cognito::UserPoolClient.LogoutURLs.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls

Return type

Optional[List[str]]

node

The construct tree node associated with this construct.

Return type

ConstructNode

prevent_user_existence_errors

AWS::Cognito::UserPoolClient.PreventUserExistenceErrors.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors

Return type

Optional[str]

read_attributes

AWS::Cognito::UserPoolClient.ReadAttributes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes

Return type

Optional[List[str]]

ref

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 }).

Return type

str

refresh_token_validity

AWS::Cognito::UserPoolClient.RefreshTokenValidity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity

Return type

Union[int, float, None]

stack

The stack in which this element is defined.

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

Return type

Stack

supported_identity_providers

AWS::Cognito::UserPoolClient.SupportedIdentityProviders.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders

Return type

Optional[List[str]]

user_pool_id

AWS::Cognito::UserPoolClient.UserPoolId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid

Return type

str

write_attributes

AWS::Cognito::UserPoolClient.WriteAttributes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes

Return type

Optional[List[str]]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

return :rtype: bool :return: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool