class CfnUserPoolClientPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnUserPoolClientPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnUserPoolClientPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnUserPoolClientPropsMixin
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolClientPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnUserPoolClientPropsMixin

Implements IMixin

Extends Mixin

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const cfnUserPoolClientPropsMixin = new cognito_mixins.CfnUserPoolClientPropsMixin({
  accessTokenValidity: 123,
  allowedOAuthFlows: ['allowedOAuthFlows'],
  allowedOAuthFlowsUserPoolClient: false,
  allowedOAuthScopes: ['allowedOAuthScopes'],
  analyticsConfiguration: {
    applicationArn: 'applicationArn',
    applicationId: 'applicationId',
    externalId: 'externalId',
    roleArn: 'roleArn',
    userDataShared: false,
  },
  authSessionValidity: 123,
  callbackUrLs: ['callbackUrLs'],
  clientName: 'clientName',
  defaultRedirectUri: 'defaultRedirectUri',
  enablePropagateAdditionalUserContextData: false,
  enableTokenRevocation: false,
  explicitAuthFlows: ['explicitAuthFlows'],
  generateSecret: false,
  idTokenValidity: 123,
  logoutUrLs: ['logoutUrLs'],
  preventUserExistenceErrors: 'preventUserExistenceErrors',
  readAttributes: ['readAttributes'],
  refreshTokenRotation: {
    feature: 'feature',
    retryGracePeriodSeconds: 123,
  },
  refreshTokenValidity: 123,
  supportedIdentityProviders: ['supportedIdentityProviders'],
  tokenValidityUnits: {
    accessToken: 'accessToken',
    idToken: 'idToken',
    refreshToken: 'refreshToken',
  },
  userPoolId: 'userPoolId',
  writeAttributes: ['writeAttributes'],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnUserPoolClientPropsMixin(props: CfnUserPoolClientMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnUserPoolClientMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Cognito::UserPoolClient.

Properties

Name	Type	Description
props	CfnUserPoolClientMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnUserPoolClientMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.