UserPoolClient is the Schema for the UserPoolClients API. Provides a Cognito User Pool Client resource.
Type
CRD
Group
cognitoidp.aws.upbound.io
Version
v1beta1
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
UserPoolClientSpec defines the desired state of UserPoolClient
No description provided.
List of allowed OAuth flows (code, implicit, client_credentials).
List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
Reference to a App in pinpoint to populate applicationId.
Policies for referencing.
Selector for a App in pinpoint to populate applicationId.
Policies for selection.
Reference to a Role in iam to populate roleArn.
Policies for referencing.
Selector for a Role in iam to populate roleArn.
Policies for selection.
List of allowed callback URLs for the identity providers.
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).
List of allowed logout URLs for the identity providers.
List of user pool attributes the application client can read from.
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).
Configuration block for units in which the validity times are represented in. Detailed below.
Reference to a UserPool in cognitoidp to populate userPoolId.
Policies for referencing.
Selector for a UserPool in cognitoidp to populate userPoolId.
Policies for selection.
List of user pool attributes the application client can write to.
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.
List of allowed OAuth flows (code, implicit, client_credentials).
List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
Reference to a App in pinpoint to populate applicationId.
Policies for referencing.
Selector for a App in pinpoint to populate applicationId.
Policies for selection.
Reference to a Role in iam to populate roleArn.
Policies for referencing.
Selector for a Role in iam to populate roleArn.
Policies for selection.
List of allowed callback URLs for the identity providers.
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).
List of allowed logout URLs for the identity providers.
List of user pool attributes the application client can read from.
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).
Configuration block for units in which the validity times are represented in. Detailed below.
Reference to a UserPool in cognitoidp to populate userPoolId.
Policies for referencing.
Selector for a UserPool in cognitoidp to populate userPoolId.
Policies for selection.
List of user pool attributes the application client can write to.
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
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
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.
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.
UserPoolClientStatus defines the observed state of UserPoolClient.
No description provided.
List of allowed OAuth flows (code, implicit, client_credentials).
List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
List of allowed callback URLs for the identity providers.
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).
List of allowed logout URLs for the identity providers.
List of user pool attributes the application client can read from.
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).
Configuration block for units in which the validity times are represented in. Detailed below.
List of user pool attributes the application client can write to.
Conditions of the resource.
userpoolclient-with-dashes
apiVersion: cognitoidp.aws.upbound.io/v1beta1
kind: UserPoolClient
metadata:
annotations:
meta.upbound.io/example-id: cognitoidp/v1beta2/userpool
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/v1beta2/userpool
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:
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