Cognito
19 resource kinds. Generated from the operator's CRD schemas.
aws.konfig.io/v1alpha1
CognitoIdentityPool # CLOUD CONTROL · AWS::Cognito::IdentityPool
CognitoIdentityPool manages AWS::Cognito::IdentityPool through the AWS Cloud Control API.
kubectl get cognitoidentitypools · example on GitHub
Example
# CognitoIdentityPool — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitoidentitypool
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoIdentityPool
metadata:
name: example-cognitoidentitypool
namespace: default
spec:
allowClassicFlow: false
allowUnauthenticatedIdentities: false
cognitoIdentityProviders:
- clientId: example-id
providerName: example-cognitoidentitypool
serverSideTokenCheck: false
cognitoStreams:
roleArn: arn:aws:iam::123456789012:role/example-role
streamName: example-cognitoidentitypool
streamingStatus: example
developerProviderName: example-cognitoidentitypool
identityPoolName: example-cognitoidentitypool
identityPoolTags:
- key: example
value: example
openIdConnectProviderARNs:
- example
providerRef:
name: example-cognitoidentitypool
region: us-east-1
pushSync:
applicationArns:
- example
roleArn: arn:aws:iam::123456789012:role/example-role
samlProviderARNs:
- example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
allowClassicFlow | boolean | — | |
allowUnauthenticatedIdentities | boolean | yes | |
cognitoEvents | object | — | |
cognitoIdentityProviders | array<object> | — | |
cognitoIdentityProviders[].clientId | string | yes | |
cognitoIdentityProviders[].providerName | string | yes | |
cognitoIdentityProviders[].serverSideTokenCheck | boolean | — | |
cognitoStreams | object | — | CognitoIdentityPoolCognitoStreams is a nested property type of AWS::Cognito::IdentityPool. |
cognitoStreams.roleArn | string | — | |
cognitoStreams.streamName | string | — | |
cognitoStreams.streamingStatus | string | — | |
developerProviderName | string | — | |
identityPoolName | string | — | |
identityPoolTags | array<object> | — | An array of key-value pairs to apply to this resource. |
identityPoolTags[].key | string | yes | |
identityPoolTags[].value | string | yes | |
openIdConnectProviderARNs | array<string> | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
pushSync | object | — | CognitoIdentityPoolPushSync is a nested property type of AWS::Cognito::IdentityPool. |
pushSync.applicationArns | array<string> | — | |
pushSync.roleArn | string | — | |
samlProviderARNs | array<string> | — | |
supportedLoginProviders | object | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
id | string | — | Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
name | string | — | Read-only: reported by AWS after creation. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoIdentityPoolPrincipalTag # CLOUD CONTROL · AWS::Cognito::IdentityPoolPrincipalTag
CognitoIdentityPoolPrincipalTag manages AWS::Cognito::IdentityPoolPrincipalTag through the AWS Cloud Control API.
kubectl get cognitoidentitypoolprincipaltags · example on GitHub
Example
# CognitoIdentityPoolPrincipalTag — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitoidentitypoolprincipaltag
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoIdentityPoolPrincipalTag
metadata:
name: example-cognitoidentitypoolprincipaltag
namespace: default
spec:
identityPoolId: example-id
identityProviderName: example-cognitoidentitypoolprincipaltag
providerRef:
name: example-cognitoidentitypoolprincipaltag
region: us-east-1
useDefaults: false
Spec
| Field | Type | Required | Description |
|---|---|---|---|
identityPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
identityProviderName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
principalTags | object | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
useDefaults | boolean | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoIdentityPoolRoleAttachment # CLOUD CONTROL · AWS::Cognito::IdentityPoolRoleAttachment
CognitoIdentityPoolRoleAttachment manages AWS::Cognito::IdentityPoolRoleAttachment through the AWS Cloud Control API.
kubectl get cognitoidentitypoolroleattachments · example on GitHub
Example
# CognitoIdentityPoolRoleAttachment — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitoidentitypoolroleattachment
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoIdentityPoolRoleAttachment
metadata:
name: example-cognitoidentitypoolroleattachment
namespace: default
spec:
identityPoolId: example-id
providerRef:
name: example-cognitoidentitypoolroleattachment
region: us-east-1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
identityPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
roleMappings | object | — | |
roles | object | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
id | string | — | Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoLogDeliveryConfiguration # CLOUD CONTROL · AWS::Cognito::LogDeliveryConfiguration
CognitoLogDeliveryConfiguration manages AWS::Cognito::LogDeliveryConfiguration through the AWS Cloud Control API.
kubectl get cognitologdeliveryconfigurations · example on GitHub
Example
# CognitoLogDeliveryConfiguration — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitologdeliveryconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoLogDeliveryConfiguration
metadata:
name: example-cognitologdeliveryconfiguration
namespace: default
spec:
logConfigurations:
- cloudWatchLogsConfiguration:
logGroupArn: arn:aws:iam::123456789012:role/example-role
eventSource: example
firehoseConfiguration:
streamArn: arn:aws:iam::123456789012:role/example-role
logLevel: example
s3Configuration:
bucketArn: arn:aws:iam::123456789012:role/example-role
providerRef:
name: example-cognitologdeliveryconfiguration
region: us-east-1
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
logConfigurations | array<object> | — | |
logConfigurations[].cloudWatchLogsConfiguration | object | — | CognitoLogDeliveryConfigurationCloudWatchLogsConfiguration is a nested property type of AWS::Cognito::LogDeliveryConfiguration. |
logConfigurations[].cloudWatchLogsConfiguration.logGroupArn | string | — | |
logConfigurations[].eventSource | string | — | |
logConfigurations[].firehoseConfiguration | object | — | CognitoLogDeliveryConfigurationFirehoseConfiguration is a nested property type of AWS::Cognito::LogDeliveryConfiguration. |
logConfigurations[].firehoseConfiguration.streamArn | string | — | |
logConfigurations[].logLevel | string | — | |
logConfigurations[].s3Configuration | object | — | CognitoLogDeliveryConfigurationS3Configuration is a nested property type of AWS::Cognito::LogDeliveryConfiguration. |
logConfigurations[].s3Configuration.bucketArn | string | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
id | string | — | Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoManagedLoginBranding # CLOUD CONTROL · AWS::Cognito::ManagedLoginBranding
CognitoManagedLoginBranding manages AWS::Cognito::ManagedLoginBranding through the AWS Cloud Control API.
kubectl get cognitomanagedloginbrandings · example on GitHub
Example
# CognitoManagedLoginBranding — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitomanagedloginbranding
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoManagedLoginBranding
metadata:
name: example-cognitomanagedloginbranding
namespace: default
spec:
assets:
- bytes: example
category: FAVICON_ICO
colorMode: LIGHT
extension: ICO
providerRef:
name: example-cognitomanagedloginbranding
region: us-east-1
returnMergedResources: false
useCognitoProvidedValues: false
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
assets | array<object> | — | |
assets[].bytes | string | — | |
assets[].category | enum | yes | Allowed: FAVICON_ICO, FAVICON_SVG, EMAIL_GRAPHIC, SMS_GRAPHIC, AUTH_APP_GRAPHIC, PASSWORD_GRAPHIC, PASSKEY_GRAPHIC, PAGE_HEADER_LOGO… |
assets[].colorMode | enum | yes | Allowed: LIGHT, DARK, DYNAMIC |
assets[].extension | enum | yes | Allowed: ICO, JPEG, PNG, SVG, WEBP |
assets[].resourceId | string | — | |
clientId | string | — | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
returnMergedResources | boolean | — | |
settings | object | — | |
useCognitoProvidedValues | boolean | — | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
managedLoginBrandingId | string | — | Read-only: reported by AWS after creation. |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoTerms # CLOUD CONTROL · AWS::Cognito::Terms
CognitoTerms manages AWS::Cognito::Terms through the AWS Cloud Control API.
kubectl get cognitoterms · example on GitHub
Example
# CognitoTerms — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitoterms
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoTerms
metadata:
name: example-cognitoterms
namespace: default
spec:
enforcement: NONE
links:
key: value
providerRef:
name: example-cognitoterms
region: us-east-1
termsName: example-cognitoterms
termsSource: LINK
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | — | Create-only in AWS: changing it requires replacing the resource. |
enforcement | enum | yes | Allowed: NONE |
links | map<string> | yes | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
termsName | string | yes | |
termsSource | enum | yes | Allowed: LINK |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
termsId | string | — | Read-only: reported by AWS after creation. |
CognitoUserPoolDomain # CLOUD CONTROL · AWS::Cognito::UserPoolDomain
CognitoUserPoolDomain manages AWS::Cognito::UserPoolDomain through the AWS Cloud Control API.
kubectl get cognitouserpooldomains · example on GitHub
Example
# CognitoUserPoolDomain — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpooldomain
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolDomain
metadata:
name: example-cognitouserpooldomain
namespace: default
spec:
customDomainConfig:
certificateArn: arn:aws:iam::123456789012:role/example-role
securityPolicy: example
domain: example
managedLoginVersion: 1
providerRef:
name: example-cognitouserpooldomain
region: us-east-1
routing:
failover:
primaryRoute53HealthCheckId: example-id
secondaryRegion: example
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
customDomainConfig | object | — | CognitoUserPoolDomainCustomDomainConfigType is a nested property type of AWS::Cognito::UserPoolDomain. |
customDomainConfig.certificateArn | string | — | |
customDomainConfig.securityPolicy | string | — | |
domain | string | yes | Create-only in AWS: changing it requires replacing the resource. |
managedLoginVersion | integer | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
routing | object | — | CognitoUserPoolDomainRoutingType is a nested property type of AWS::Cognito::UserPoolDomain. |
routing.failover | object | — | CognitoUserPoolDomainFailoverType is a nested property type of AWS::Cognito::UserPoolDomain. |
routing.failover.primaryRoute53HealthCheckId | string | yes | |
routing.failover.secondaryRegion | string | yes | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
cloudFrontDistribution | string | — | Read-only: reported by AWS after creation. |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolGroup # CLOUD CONTROL · AWS::Cognito::UserPoolGroup
CognitoUserPoolGroup manages AWS::Cognito::UserPoolGroup through the AWS Cloud Control API.
kubectl get cognitouserpoolgroups · example on GitHub
Example
# CognitoUserPoolGroup — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolgroup
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolGroup
metadata:
name: example-cognitouserpoolgroup
namespace: default
spec:
description: Managed by konfig-konector
groupName: example-cognitouserpoolgroup
precedence: 1
providerRef:
name: example-cognitouserpoolgroup
region: us-east-1
roleArn: arn:aws:iam::123456789012:role/example-role
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | |
groupName | string | — | Create-only in AWS: changing it requires replacing the resource. |
precedence | integer | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
roleArn | string | — | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolIdentityProvider # CLOUD CONTROL · AWS::Cognito::UserPoolIdentityProvider
CognitoUserPoolIdentityProvider manages AWS::Cognito::UserPoolIdentityProvider through the AWS Cloud Control API.
kubectl get cognitouserpoolidentityproviders · example on GitHub
Example
# CognitoUserPoolIdentityProvider — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolidentityprovider
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolIdentityProvider
metadata:
name: example-cognitouserpoolidentityprovider
namespace: default
spec:
attributeMapping:
key: value
idpIdentifiers:
- example
providerDetails:
key: value
providerName: example-cognitouserpoolidentityprovider
providerRef:
name: example-cognitouserpoolidentityprovider
region: us-east-1
providerType: example
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
attributeMapping | map<string> | — | |
idpIdentifiers | array<string> | — | |
providerDetails | map<string> | yes | |
providerName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
providerType | string | yes | Create-only in AWS: changing it requires replacing the resource. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolRegionalConfigurationAttachment # CLOUD CONTROL · AWS::Cognito::UserPoolRegionalConfigurationAttachment
CognitoUserPoolRegionalConfigurationAttachment manages AWS::Cognito::UserPoolRegionalConfigurationAttachment through the AWS Cloud Control API.
kubectl get cognitouserpoolregionalconfigurationattachments · example on GitHub
Example
# CognitoUserPoolRegionalConfigurationAttachment — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolregionalconfigurationattachment
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolRegionalConfigurationAttachment
metadata:
name: example-cognitouserpoolregionalconfigurationattachment
namespace: default
spec:
emailConfiguration:
configurationSet: example
emailSendingAccount: ops@example.com
from: example
replyToEmailAddress: ops@example.com
sourceArn: arn:aws:iam::123456789012:role/example-role
lambdaConfig:
createAuthChallenge: example
customEmailSender:
lambdaArn: arn:aws:iam::123456789012:role/example-role
lambdaVersion: '1.0'
customMessage: example
customSMSSender:
lambdaArn: arn:aws:iam::123456789012:role/example-role
lambdaVersion: '1.0'
defineAuthChallenge: example
inboundFederation:
lambdaArn: arn:aws:iam::123456789012:role/example-role
lambdaVersion: '1.0'
kmsKeyID: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
postAuthentication: example
postConfirmation: example
preAuthentication: example
preSignUp: example
preTokenGeneration: example
preTokenGenerationConfig:
lambdaArn: arn:aws:iam::123456789012:role/example-role
lambdaVersion: '1.0'
userMigration: example
verifyAuthChallengeResponse: example
providerRef:
name: example-cognitouserpoolregionalconfigurationattachment
region: us-east-1
smsConfiguration:
eumsSms:
callerArn: arn:aws:iam::123456789012:role/example-role
configurationSetName: example-cognitouserpoolregionalconfigurationattachment
originationIdentity: example
region: us-east-1
snsCallerArn: arn:aws:iam::123456789012:role/example-role
snsRegion: example
status: example
userPoolId: example-id
userPoolTags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
emailConfiguration | object | — | CognitoUserPoolRegionalConfigurationAttachmentEmailConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
emailConfiguration.configurationSet | string | — | |
emailConfiguration.emailSendingAccount | string | — | |
emailConfiguration.from | string | — | |
emailConfiguration.replyToEmailAddress | string | — | |
emailConfiguration.sourceArn | string | — | |
lambdaConfig | object | — | CognitoUserPoolRegionalConfigurationAttachmentLambdaConfig is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
lambdaConfig.createAuthChallenge | string | — | |
lambdaConfig.customEmailSender | object | — | CognitoUserPoolRegionalConfigurationAttachmentCustomEmailSender is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
lambdaConfig.customEmailSender.lambdaArn | string | — | |
lambdaConfig.customEmailSender.lambdaVersion | string | — | |
lambdaConfig.customMessage | string | — | |
lambdaConfig.customSMSSender | object | — | CognitoUserPoolRegionalConfigurationAttachmentCustomSMSSender is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
lambdaConfig.customSMSSender.lambdaArn | string | — | |
lambdaConfig.customSMSSender.lambdaVersion | string | — | |
lambdaConfig.defineAuthChallenge | string | — | |
lambdaConfig.inboundFederation | object | — | CognitoUserPoolRegionalConfigurationAttachmentInboundFederation is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
lambdaConfig.inboundFederation.lambdaArn | string | — | |
lambdaConfig.inboundFederation.lambdaVersion | string | — | |
lambdaConfig.kmsKeyID | string | — | |
lambdaConfig.postAuthentication | string | — | |
lambdaConfig.postConfirmation | string | — | |
lambdaConfig.preAuthentication | string | — | |
lambdaConfig.preSignUp | string | — | |
lambdaConfig.preTokenGeneration | string | — | |
lambdaConfig.preTokenGenerationConfig | object | — | CognitoUserPoolRegionalConfigurationAttachmentPreTokenGenerationConfig is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
lambdaConfig.preTokenGenerationConfig.lambdaArn | string | — | |
lambdaConfig.preTokenGenerationConfig.lambdaVersion | string | — | |
lambdaConfig.userMigration | string | — | |
lambdaConfig.verifyAuthChallengeResponse | string | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
smsConfiguration | object | — | CognitoUserPoolRegionalConfigurationAttachmentSmsConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
smsConfiguration.eumsSms | object | — | CognitoUserPoolRegionalConfigurationAttachmentEumsSmsConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment. |
smsConfiguration.eumsSms.callerArn | string | yes | |
smsConfiguration.eumsSms.configurationSetName | string | — | |
smsConfiguration.eumsSms.externalId | string | — | |
smsConfiguration.eumsSms.inEntityId | string | — | |
smsConfiguration.eumsSms.inTemplateId | string | — | |
smsConfiguration.eumsSms.originationIdentity | string | — | |
smsConfiguration.eumsSms.region | string | — | |
smsConfiguration.externalId | string | — | |
smsConfiguration.snsCallerArn | string | — | |
smsConfiguration.snsRegion | string | — | |
status | string | — | The status of the replica. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
userPoolTags | map<string> | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolReplica # CLOUD CONTROL · AWS::Cognito::UserPoolReplica
CognitoUserPoolReplica manages AWS::Cognito::UserPoolReplica through the AWS Cloud Control API.
kubectl get cognitouserpoolreplicas · example on GitHub
Example
# CognitoUserPoolReplica — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolreplica
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolReplica
metadata:
name: example-cognitouserpoolreplica
namespace: default
spec:
providerRef:
name: example-cognitouserpoolreplica
region: us-east-1
regionName: example-cognitouserpoolreplica
userPoolId: example-id
userPoolTagsAtCreate:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
regionName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
userPoolTagsAtCreate | map<string> | — | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolResourceServer # CLOUD CONTROL · AWS::Cognito::UserPoolResourceServer
CognitoUserPoolResourceServer manages AWS::Cognito::UserPoolResourceServer through the AWS Cloud Control API.
kubectl get cognitouserpoolresourceservers · example on GitHub
Example
# CognitoUserPoolResourceServer — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolresourceserver
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolResourceServer
metadata:
name: example-cognitouserpoolresourceserver
namespace: default
spec:
identifier: example
name: example-cognitouserpoolresourceserver
providerRef:
name: example-cognitouserpoolresourceserver
region: us-east-1
scopes:
- scopeDescription: Managed by konfig-konector
scopeName: example-cognitouserpoolresourceserver
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
identifier | string | yes | Create-only in AWS: changing it requires replacing the resource. |
name | string | yes | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
scopes | array<object> | — | |
scopes[].scopeDescription | string | yes | |
scopes[].scopeName | string | yes | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolRiskConfigurationAttachment # CLOUD CONTROL · AWS::Cognito::UserPoolRiskConfigurationAttachment
CognitoUserPoolRiskConfigurationAttachment manages AWS::Cognito::UserPoolRiskConfigurationAttachment through the AWS Cloud Control API.
kubectl get cognitouserpoolriskconfigurationattachments · example on GitHub
Example
# CognitoUserPoolRiskConfigurationAttachment — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolriskconfigurationattachment
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolRiskConfigurationAttachment
metadata:
name: example-cognitouserpoolriskconfigurationattachment
namespace: default
spec:
accountTakeoverRiskConfiguration:
actions:
highAction:
eventAction: example
notify: false
lowAction:
eventAction: example
notify: false
mediumAction:
eventAction: example
notify: false
notifyConfiguration:
blockEmail:
htmlBody: example
subject: example
textBody: example
from: example
mfaEmail:
htmlBody: example
subject: example
textBody: example
noActionEmail:
htmlBody: example
subject: example
textBody: example
replyTo: example
sourceArn: arn:aws:iam::123456789012:role/example-role
clientId: example-id
compromisedCredentialsRiskConfiguration:
actions:
eventAction: example
eventFilter:
- example
providerRef:
name: example-cognitouserpoolriskconfigurationattachment
region: us-east-1
riskExceptionConfiguration:
blockedIPRangeList:
- example
skippedIPRangeList:
- example
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
accountTakeoverRiskConfiguration | object | — | CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.actions | object | yes | CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.actions.highAction | object | — | CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.actions.highAction.eventAction | string | yes | |
accountTakeoverRiskConfiguration.actions.highAction.notify | boolean | yes | |
accountTakeoverRiskConfiguration.actions.lowAction | object | — | CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.actions.lowAction.eventAction | string | yes | |
accountTakeoverRiskConfiguration.actions.lowAction.notify | boolean | yes | |
accountTakeoverRiskConfiguration.actions.mediumAction | object | — | CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.actions.mediumAction.eventAction | string | yes | |
accountTakeoverRiskConfiguration.actions.mediumAction.notify | boolean | yes | |
accountTakeoverRiskConfiguration.notifyConfiguration | object | — | CognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail | object | — | CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.htmlBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.subject | string | yes | |
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.textBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.from | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail | object | — | CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.htmlBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.subject | string | yes | |
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.textBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail | object | — | CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.htmlBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.subject | string | yes | |
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.textBody | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.replyTo | string | — | |
accountTakeoverRiskConfiguration.notifyConfiguration.sourceArn | string | yes | |
clientId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
compromisedCredentialsRiskConfiguration | object | — | CognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
compromisedCredentialsRiskConfiguration.actions | object | yes | CognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
compromisedCredentialsRiskConfiguration.actions.eventAction | string | yes | |
compromisedCredentialsRiskConfiguration.eventFilter | array<string> | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
riskExceptionConfiguration | object | — | CognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment. |
riskExceptionConfiguration.blockedIPRangeList | array<string> | — | |
riskExceptionConfiguration.skippedIPRangeList | array<string> | — | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolUICustomizationAttachment # CLOUD CONTROL · AWS::Cognito::UserPoolUICustomizationAttachment
CognitoUserPoolUICustomizationAttachment manages AWS::Cognito::UserPoolUICustomizationAttachment through the AWS Cloud Control API.
kubectl get cognitouserpooluicustomizationattachments · example on GitHub
Example
# CognitoUserPoolUICustomizationAttachment — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpooluicustomizationattachment
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolUICustomizationAttachment
metadata:
name: example-cognitouserpooluicustomizationattachment
namespace: default
spec:
clientId: example-id
css: example
providerRef:
name: example-cognitouserpooluicustomizationattachment
region: us-east-1
userPoolId: example-id
Spec
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
css | string | — | |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolUser # CLOUD CONTROL · AWS::Cognito::UserPoolUser
CognitoUserPoolUser manages AWS::Cognito::UserPoolUser through the AWS Cloud Control API.
kubectl get cognitouserpoolusers · example on GitHub
Example
# CognitoUserPoolUser — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpooluser
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolUser
metadata:
name: example-cognitouserpooluser
namespace: default
spec:
clientMetadata:
key: value
desiredDeliveryMediums:
- example
forceAliasCreation: false
messageAction: example
providerRef:
name: example-cognitouserpooluser
region: us-east-1
userAttributes:
- name: example-cognitouserpooluser
value: example
userPoolId: example-id
username: example-cognitouserpooluser
validationData:
- name: example-cognitouserpooluser
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
clientMetadata | map<string> | — | Create-only in AWS: changing it requires replacing the resource. |
desiredDeliveryMediums | array<string> | — | Create-only in AWS: changing it requires replacing the resource. |
forceAliasCreation | boolean | — | Create-only in AWS: changing it requires replacing the resource. |
messageAction | string | — | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
userAttributes | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
userAttributes[].name | string | — | |
userAttributes[].value | string | — | |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
username | string | — | Create-only in AWS: changing it requires replacing the resource. |
validationData | array<object> | — | Create-only in AWS: changing it requires replacing the resource. |
validationData[].name | string | — | |
validationData[].value | string | — |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
CognitoUserPoolUserToGroupAttachment # CLOUD CONTROL · AWS::Cognito::UserPoolUserToGroupAttachment
CognitoUserPoolUserToGroupAttachment manages AWS::Cognito::UserPoolUserToGroupAttachment through the AWS Cloud Control API.
kubectl get cognitouserpoolusertogroupattachments · example on GitHub
Example
# CognitoUserPoolUserToGroupAttachment — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#cognitouserpoolusertogroupattachment
apiVersion: aws.konfig.io/v1alpha1
kind: CognitoUserPoolUserToGroupAttachment
metadata:
name: example-cognitouserpoolusertogroupattachment
namespace: default
spec:
groupName: example-cognitouserpoolusertogroupattachment
providerRef:
name: example-cognitouserpoolusertogroupattachment
region: us-east-1
userPoolId: example-id
username: example-cognitouserpoolusertogroupattachment
Spec
| Field | Type | Required | Description |
|---|---|---|---|
groupName | string | yes | Create-only in AWS: changing it requires replacing the resource. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
userPoolId | string | yes | Create-only in AWS: changing it requires replacing the resource. |
username | string | yes | Create-only in AWS: changing it requires replacing the resource. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
IdentityProvider # GA
IdentityProvider is the Schema for managing Cognito Identity Providers.
kubectl get identityproviders · example on GitHub
Example
# IdentityProvider — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#identityprovider
apiVersion: aws.konfig.io/v1alpha1
kind: IdentityProvider
metadata:
name: example-identityprovider
namespace: default
spec:
attributeMapping:
key: value
idpIdentifiers:
- example
providerDetails:
key: value
providerName: example-identityprovider
providerRef:
name: example-identityprovider
region: us-east-1
providerType: SAML
userPoolRef:
name: example-identityprovider
Spec
| Field | Type | Required | Description |
|---|---|---|---|
attributeMapping | map<string> | — | AttributeMapping maps provider attributes to user pool attributes. |
idpIdentifiers | array<string> | — | IdpIdentifiers are alternative identifiers for the IdP. |
providerDetails | map<string> | yes | ProviderDetails are the provider-specific settings. |
providerName | string | yes | ProviderName is the identity provider name. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
providerType | enum | yes | ProviderType is the identity provider type. Allowed: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC |
userPoolRef | object | yes | UserPoolRef references the user pool. |
userPoolRef.name | string | — | Name of a UserPool CR in the same namespace. |
userPoolRef.userPoolId | string | — | UserPoolID is a direct AWS Cognito user pool ID. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
UserPool # GA
UserPool is the Schema for managing Cognito User Pools.
kubectl get userpools · example on GitHub
Example
# UserPool — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#userpool
apiVersion: aws.konfig.io/v1alpha1
kind: UserPool
metadata:
name: example-userpool
namespace: default
spec:
autoVerifiedAttributes:
- example
mfaConfiguration: 'OFF'
passwordPolicy:
minimumLength: 6
requireLowercase: false
requireNumbers: false
requireSymbols: false
requireUppercase: false
poolName: example-userpool
providerRef:
name: example-userpool
region: us-east-1
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
autoVerifiedAttributes | array<string> | — | AutoVerifiedAttributes are the attributes to auto-verify (email, phone_number). |
mfaConfiguration | enum | — | MfaConfiguration sets MFA. Allowed: OFF, ON, OPTIONAL |
passwordPolicy | object | — | PasswordPolicy defines the password policy. |
passwordPolicy.minimumLength | integer | — | MinimumLength is the minimum password length. |
passwordPolicy.requireLowercase | boolean | — | RequireLowercase requires lowercase letters. |
passwordPolicy.requireNumbers | boolean | — | RequireNumbers requires numbers. |
passwordPolicy.requireSymbols | boolean | — | RequireSymbols requires symbols. |
passwordPolicy.requireUppercase | boolean | — | RequireUppercase requires uppercase letters. |
poolName | string | yes | PoolName is the name of the user pool. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | map<string> | — | Tags are AWS resource tags to apply. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
arn | string | — | ARN is the ARN of the user pool. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
userPoolId | string | — | UserPoolID is the AWS Cognito user pool ID. |
UserPoolClient # GA
UserPoolClient is the Schema for managing Cognito User Pool App Clients.
kubectl get userpoolclients · example on GitHub
Example
# UserPoolClient — Cognito
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/cognito.html#userpoolclient
apiVersion: aws.konfig.io/v1alpha1
kind: UserPoolClient
metadata:
name: example-userpoolclient
namespace: default
spec:
accessTokenValidity: 1
allowedOAuthFlows:
- example
allowedOAuthScopes:
- example
callbackUrls:
- example
clientName: example-userpoolclient
explicitAuthFlows:
- example
generateSecret: false
idTokenValidity: 1
logoutUrls:
- example
providerRef:
name: example-userpoolclient
region: us-east-1
refreshTokenValidity: 1
supportedIdentityProviders:
- example
userPoolRef:
name: example-userpoolclient
Spec
| Field | Type | Required | Description |
|---|---|---|---|
accessTokenValidity | integer | — | AccessTokenValidity is the access token validity in minutes (1-86400). |
allowedOAuthFlows | array<string> | — | AllowedOAuthFlows are the allowed OAuth flows. |
allowedOAuthScopes | array<string> | — | AllowedOAuthScopes are the allowed OAuth scopes. |
callbackUrls | array<string> | — | CallbackURLs are the allowed callback URLs. |
clientName | string | yes | ClientName is the name of the app client. |
explicitAuthFlows | array<string> | — | ExplicitAuthFlows are the authentication flows to allow. |
generateSecret | boolean | — | GenerateSecret generates a client secret. |
idTokenValidity | integer | — | IdTokenValidity is the ID token validity in minutes (1-86400). |
logoutUrls | array<string> | — | LogoutURLs are the allowed sign-out URLs. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
refreshTokenValidity | integer | — | RefreshTokenValidity is the refresh token validity in days (1-3650). |
supportedIdentityProviders | array<string> | — | SupportedIdentityProviders are the supported identity providers. |
userPoolRef | object | yes | UserPoolRef references the user pool. |
userPoolRef.name | string | — | Name of a UserPool CR in the same namespace. |
userPoolRef.userPoolId | string | — | UserPoolID is a direct AWS Cognito user pool ID. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
clientId | string | — | ClientID is the AWS Cognito app client ID. |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
lastSyncTime | string | — | LastSyncTime is when the resource was last successfully reconciled. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |