UserPoolClient - upbound/provider-aws@v1.3.1

List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).

generateSecret

boolean

idTokenValidity

number

logoutUrls

array

List of allowed logout URLs for the identity providers.

name

string

preventUserExistenceErrors

string

readAttributes

array

List of user pool attributes the application client can read from.

refreshTokenValidity

number

region

requiredstring

supportedIdentityProviders

array

List of provider names for the identity providers that are supported on this client. Uses the provider_name attribute of aws_cognito_identity_provider resource(s), or the equivalent string(s).

tokenValidityUnits

array

Configuration block for units in which the validity times are represented in. Detailed below.

string

string

string

string

object

Reference to a UserPool to populate userPoolId.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

userPoolIdSelector

object

Selector for a UserPool to populate userPoolId.

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

resolution

string

resolve

string

writeAttributes

array

List of user pool attributes the application client can write to.

initProvider

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

accessTokenValidity

number

allowedOauthFlows

array

List of allowed OAuth flows (code, implicit, client_credentials).

allowedOauthFlowsUserPoolClient

boolean

allowedOauthScopes

array

List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

analyticsConfiguration

array

Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.

applicationArn

string

applicationId

string

applicationIdRef

object

Reference to a App in pinpoint to populate applicationId.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

applicationIdSelector

object

Selector for a App in pinpoint to populate applicationId.

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

string

string

string

string

object

Reference to a Role in iam to populate roleArn.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

roleArnSelector

object

Selector for a Role in iam to populate roleArn.

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

string

string

boolean

number

array

List of allowed callback URLs for the identity providers.

defaultRedirectUri

string

enablePropagateAdditionalUserContextData

boolean

enableTokenRevocation

boolean

array

boolean

number

array

List of allowed logout URLs for the identity providers.

name

string

preventUserExistenceErrors

string

readAttributes

array

List of user pool attributes the application client can read from.

refreshTokenValidity

number

supportedIdentityProviders

array

List of provider names for the identity providers that are supported on this client. Uses the provider_name attribute of aws_cognito_identity_provider resource(s), or the equivalent string(s).

tokenValidityUnits

array

Configuration block for units in which the validity times are represented in. Detailed below.

string

string

string

string

object

Reference to a UserPool to populate userPoolId.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

userPoolIdSelector

object

Selector for a UserPool to populate userPoolId.

matchControllerRef

boolean

matchLabels

object

policy

object

Policies for selection.

resolution

string

resolve

string

writeAttributes

array

List of user pool attributes the application client can write to.

managementPolicies

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

providerConfigRef

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

publishConnectionDetailsTo

object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef

object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name

requiredstring

policy

object

Policies for referencing.

resolution

string

resolve

string

metadata

object

Metadata is the metadata for connection secret.

object

object

string

requiredstring

writeConnectionSecretToRef

object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name

requiredstring

namespace

requiredstring

status

object

UserPoolClientStatus defines the observed state of UserPoolClient.

atProvider

object

No description provided.

accessTokenValidity

number

allowedOauthFlows

array

List of allowed OAuth flows (code, implicit, client_credentials).

allowedOauthFlowsUserPoolClient

boolean

allowedOauthScopes

array

List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

analyticsConfiguration

array

Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.

string

string

string

string

boolean

number

array

List of allowed callback URLs for the identity providers.

defaultRedirectUri

string

enablePropagateAdditionalUserContextData

boolean

enableTokenRevocation

boolean

explicitAuthFlows

array

generateSecret

boolean

string

idTokenValidity

number

logoutUrls

array

List of allowed logout URLs for the identity providers.

name

string

preventUserExistenceErrors

string

readAttributes

array

List of user pool attributes the application client can read from.

refreshTokenValidity

number

supportedIdentityProviders

array

List of provider names for the identity providers that are supported on this client. Uses the provider_name attribute of aws_cognito_identity_provider resource(s), or the equivalent string(s).

tokenValidityUnits

array

Configuration block for units in which the validity times are represented in. Detailed below.

string

string

string

string

array

List of user pool attributes the application client can write to.

conditions

array

Conditions of the resource.

requiredstring

string

requiredstring

requiredstring

requiredstring

example

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  labels:
    testing.upbound.io/example-name: example
  name: example
spec:
  forProvider:
    name: client
    region: us-west-1
    supportedIdentityProviders:
      - COGNITO
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: example

example

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  annotations:
    meta.upbound.io/example-id: sagemaker/v1beta1/workteam
  labels:
    testing.upbound.io/example-name: example
  name: example
spec:
  forProvider:
    generateSecret: true
    name: example
    region: us-west-2
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: main

example

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  labels:
    testing.upbound.io/example-name: example
  name: example
spec:
  forProvider:
    name: example
    region: us-west-1
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: example

userpoolclient-with-dashes

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  labels:
    testing.upbound.io/example-name: userpoolclient
  name: userpoolclient-with-dashes
spec:
  forProvider:
    name: name-that-doesnt-match-id-regex
    region: us-west-1
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: userpoolclient

userpoolclient

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  annotations:
    meta.upbound.io/example-id: cognitoidp/v1beta1/userpoolclient
  labels:
    testing.upbound.io/example-name: userpoolclient
  name: userpoolclient
spec:
  forProvider:
    name: userpoolclient
    region: us-west-1
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: userpoolclient

example

apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
  annotations:
    meta.upbound.io/example-id: sagemaker/v1beta1/workforce
  labels:
    testing.upbound.io/example-name: example
  name: example
spec:
  forProvider:
    generateSecret: true
    name: example
    region: us-west-2
    userPoolIdSelector:
      matchLabels:
        testing.upbound.io/example-name: example

Marketplace

Discover the building blocks for your internal cloud platform.

SolutionsProviders Configurations

LearnDocumentation Try for Free

CompanyAbout Contact Us

MorePrivacy Policy Terms & Conditions

Marketplace

Discover the building blocksfor your internal cloud platform.