software.amazon.awscdk.services.cognito

Class CfnUserPoolClient

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolClient

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.281Z")
 @Stability(value=Stable)
public class CfnUserPoolClient
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolClient`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnUserPoolClient.AnalyticsConfigurationProperty
static class	CfnUserPoolClient.Builder A fluent builder for CfnUserPoolClient.
static interface	CfnUserPoolClient.TokenValidityUnitsProperty

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolClient(software.constructs.Construct scope, String id, CfnUserPoolClientProps props) Create a new `AWS::Cognito::UserPoolClient`.
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getAccessTokenValidity() `AWS::Cognito::UserPoolClient.AccessTokenValidity`.
List<String>	getAllowedOAuthFlows() `AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.
Object	getAllowedOAuthFlowsUserPoolClient() `AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.
List<String>	getAllowedOAuthScopes() `AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.
Object	getAnalyticsConfiguration() `AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.
String	getAttrClientSecret()
String	getAttrName()
List<String>	getCallbackUrLs() `AWS::Cognito::UserPoolClient.CallbackURLs`.
protected Map<String,Object>	getCfnProperties()
String	getClientName() `AWS::Cognito::UserPoolClient.ClientName`.
String	getDefaultRedirectUri() `AWS::Cognito::UserPoolClient.DefaultRedirectURI`.
List<String>	getExplicitAuthFlows() `AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.
Object	getGenerateSecret() `AWS::Cognito::UserPoolClient.GenerateSecret`.
Number	getIdTokenValidity() `AWS::Cognito::UserPoolClient.IdTokenValidity`.
List<String>	getLogoutUrLs() `AWS::Cognito::UserPoolClient.LogoutURLs`.
String	getPreventUserExistenceErrors() `AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.
List<String>	getReadAttributes() `AWS::Cognito::UserPoolClient.ReadAttributes`.
Number	getRefreshTokenValidity() `AWS::Cognito::UserPoolClient.RefreshTokenValidity`.
List<String>	getSupportedIdentityProviders() `AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.
Object	getTokenValidityUnits() `AWS::Cognito::UserPoolClient.TokenValidityUnits`.
String	getUserPoolId() `AWS::Cognito::UserPoolClient.UserPoolId`.
List<String>	getWriteAttributes() `AWS::Cognito::UserPoolClient.WriteAttributes`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessTokenValidity(Number value) `AWS::Cognito::UserPoolClient.AccessTokenValidity`.
void	setAllowedOAuthFlows(List<String> value) `AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.
void	setAllowedOAuthFlowsUserPoolClient(Boolean value) `AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.
void	setAllowedOAuthFlowsUserPoolClient(IResolvable value) `AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.
void	setAllowedOAuthScopes(List<String> value) `AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.
void	setAnalyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty value) `AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.
void	setAnalyticsConfiguration(IResolvable value) `AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.
void	setCallbackUrLs(List<String> value) `AWS::Cognito::UserPoolClient.CallbackURLs`.
void	setClientName(String value) `AWS::Cognito::UserPoolClient.ClientName`.
void	setDefaultRedirectUri(String value) `AWS::Cognito::UserPoolClient.DefaultRedirectURI`.
void	setExplicitAuthFlows(List<String> value) `AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.
void	setGenerateSecret(Boolean value) `AWS::Cognito::UserPoolClient.GenerateSecret`.
void	setGenerateSecret(IResolvable value) `AWS::Cognito::UserPoolClient.GenerateSecret`.
void	setIdTokenValidity(Number value) `AWS::Cognito::UserPoolClient.IdTokenValidity`.
void	setLogoutUrLs(List<String> value) `AWS::Cognito::UserPoolClient.LogoutURLs`.
void	setPreventUserExistenceErrors(String value) `AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.
void	setReadAttributes(List<String> value) `AWS::Cognito::UserPoolClient.ReadAttributes`.
void	setRefreshTokenValidity(Number value) `AWS::Cognito::UserPoolClient.RefreshTokenValidity`.
void	setSupportedIdentityProviders(List<String> value) `AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.
void	setTokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty value) `AWS::Cognito::UserPoolClient.TokenValidityUnits`.
void	setTokenValidityUnits(IResolvable value) `AWS::Cognito::UserPoolClient.TokenValidityUnits`.
void	setUserPoolId(String value) `AWS::Cognito::UserPoolClient.UserPoolId`.
void	setWriteAttributes(List<String> value) `AWS::Cognito::UserPoolClient.WriteAttributes`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolClient

protected CfnUserPoolClient(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolClient

protected CfnUserPoolClient(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolClient

@Stability(value=Stable)
public CfnUserPoolClient(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnUserPoolClientProps props)

Create a new `AWS::Cognito::UserPoolClient`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrClientSecret

@Stability(value=Stable)
 @NotNull
public String getAttrClientSecret()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserPoolId

@Stability(value=Stable)
 @NotNull
public String getUserPoolId()

`AWS::Cognito::UserPoolClient.UserPoolId`.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

`AWS::Cognito::UserPoolClient.UserPoolId`.

getAccessTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getAccessTokenValidity()

`AWS::Cognito::UserPoolClient.AccessTokenValidity`.

setAccessTokenValidity

@Stability(value=Stable)
public void setAccessTokenValidity(@Nullable
                                                            Number value)

`AWS::Cognito::UserPoolClient.AccessTokenValidity`.

getAllowedOAuthFlows

@Stability(value=Stable)
 @Nullable
public List<String> getAllowedOAuthFlows()

`AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.

setAllowedOAuthFlows

@Stability(value=Stable)
public void setAllowedOAuthFlows(@Nullable
                                                          List<String> value)

`AWS::Cognito::UserPoolClient.AllowedOAuthFlows`.

getAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
 @Nullable
public Object getAllowedOAuthFlowsUserPoolClient()

`AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.

setAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public void setAllowedOAuthFlowsUserPoolClient(@Nullable
                                                                        Boolean value)

`AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.

setAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public void setAllowedOAuthFlowsUserPoolClient(@Nullable
                                                                        IResolvable value)

`AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient`.

getAllowedOAuthScopes

@Stability(value=Stable)
 @Nullable
public List<String> getAllowedOAuthScopes()

`AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.

setAllowedOAuthScopes

@Stability(value=Stable)
public void setAllowedOAuthScopes(@Nullable
                                                           List<String> value)

`AWS::Cognito::UserPoolClient.AllowedOAuthScopes`.

getAnalyticsConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAnalyticsConfiguration()

`AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.

setAnalyticsConfiguration

@Stability(value=Stable)
public void setAnalyticsConfiguration(@Nullable
                                                               CfnUserPoolClient.AnalyticsConfigurationProperty value)

`AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.

setAnalyticsConfiguration

@Stability(value=Stable)
public void setAnalyticsConfiguration(@Nullable
                                                               IResolvable value)

`AWS::Cognito::UserPoolClient.AnalyticsConfiguration`.

getCallbackUrLs

@Stability(value=Stable)
 @Nullable
public List<String> getCallbackUrLs()

`AWS::Cognito::UserPoolClient.CallbackURLs`.

setCallbackUrLs

@Stability(value=Stable)
public void setCallbackUrLs(@Nullable
                                                     List<String> value)

`AWS::Cognito::UserPoolClient.CallbackURLs`.

getClientName

@Stability(value=Stable)
 @Nullable
public String getClientName()

`AWS::Cognito::UserPoolClient.ClientName`.

setClientName

@Stability(value=Stable)
public void setClientName(@Nullable
                                                   String value)

`AWS::Cognito::UserPoolClient.ClientName`.

getDefaultRedirectUri

@Stability(value=Stable)
 @Nullable
public String getDefaultRedirectUri()

`AWS::Cognito::UserPoolClient.DefaultRedirectURI`.

setDefaultRedirectUri

@Stability(value=Stable)
public void setDefaultRedirectUri(@Nullable
                                                           String value)

`AWS::Cognito::UserPoolClient.DefaultRedirectURI`.

getExplicitAuthFlows

@Stability(value=Stable)
 @Nullable
public List<String> getExplicitAuthFlows()

`AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.

setExplicitAuthFlows

@Stability(value=Stable)
public void setExplicitAuthFlows(@Nullable
                                                          List<String> value)

`AWS::Cognito::UserPoolClient.ExplicitAuthFlows`.

getGenerateSecret

@Stability(value=Stable)
 @Nullable
public Object getGenerateSecret()

`AWS::Cognito::UserPoolClient.GenerateSecret`.

setGenerateSecret

@Stability(value=Stable)
public void setGenerateSecret(@Nullable
                                                       Boolean value)

`AWS::Cognito::UserPoolClient.GenerateSecret`.

setGenerateSecret

@Stability(value=Stable)
public void setGenerateSecret(@Nullable
                                                       IResolvable value)

`AWS::Cognito::UserPoolClient.GenerateSecret`.

getIdTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getIdTokenValidity()

`AWS::Cognito::UserPoolClient.IdTokenValidity`.

setIdTokenValidity

@Stability(value=Stable)
public void setIdTokenValidity(@Nullable
                                                        Number value)

`AWS::Cognito::UserPoolClient.IdTokenValidity`.

getLogoutUrLs

@Stability(value=Stable)
 @Nullable
public List<String> getLogoutUrLs()

`AWS::Cognito::UserPoolClient.LogoutURLs`.

setLogoutUrLs

@Stability(value=Stable)
public void setLogoutUrLs(@Nullable
                                                   List<String> value)

`AWS::Cognito::UserPoolClient.LogoutURLs`.

getPreventUserExistenceErrors

@Stability(value=Stable)
 @Nullable
public String getPreventUserExistenceErrors()

`AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.

setPreventUserExistenceErrors

@Stability(value=Stable)
public void setPreventUserExistenceErrors(@Nullable
                                                                   String value)

`AWS::Cognito::UserPoolClient.PreventUserExistenceErrors`.

getReadAttributes

@Stability(value=Stable)
 @Nullable
public List<String> getReadAttributes()

`AWS::Cognito::UserPoolClient.ReadAttributes`.

setReadAttributes

@Stability(value=Stable)
public void setReadAttributes(@Nullable
                                                       List<String> value)

`AWS::Cognito::UserPoolClient.ReadAttributes`.

getRefreshTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getRefreshTokenValidity()

`AWS::Cognito::UserPoolClient.RefreshTokenValidity`.

setRefreshTokenValidity

@Stability(value=Stable)
public void setRefreshTokenValidity(@Nullable
                                                             Number value)

`AWS::Cognito::UserPoolClient.RefreshTokenValidity`.

getSupportedIdentityProviders

@Stability(value=Stable)
 @Nullable
public List<String> getSupportedIdentityProviders()

`AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.

setSupportedIdentityProviders

@Stability(value=Stable)
public void setSupportedIdentityProviders(@Nullable
                                                                   List<String> value)

`AWS::Cognito::UserPoolClient.SupportedIdentityProviders`.

getTokenValidityUnits

@Stability(value=Stable)
 @Nullable
public Object getTokenValidityUnits()

`AWS::Cognito::UserPoolClient.TokenValidityUnits`.

setTokenValidityUnits

@Stability(value=Stable)
public void setTokenValidityUnits(@Nullable
                                                           CfnUserPoolClient.TokenValidityUnitsProperty value)

`AWS::Cognito::UserPoolClient.TokenValidityUnits`.

setTokenValidityUnits

@Stability(value=Stable)
public void setTokenValidityUnits(@Nullable
                                                           IResolvable value)

`AWS::Cognito::UserPoolClient.TokenValidityUnits`.

getWriteAttributes

@Stability(value=Stable)
 @Nullable
public List<String> getWriteAttributes()

`AWS::Cognito::UserPoolClient.WriteAttributes`.

setWriteAttributes

@Stability(value=Stable)
public void setWriteAttributes(@Nullable
                                                        List<String> value)

`AWS::Cognito::UserPoolClient.WriteAttributes`.