Cognito

19 resource kinds. Generated from the operator's CRD schemas.

API Group: 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

FieldTypeRequiredDescription
allowClassicFlowboolean—
allowUnauthenticatedIdentitiesbooleanyes
cognitoEventsobject—
cognitoIdentityProvidersarray<object>—
cognitoIdentityProviders[].clientIdstringyes
cognitoIdentityProviders[].providerNamestringyes
cognitoIdentityProviders[].serverSideTokenCheckboolean—
cognitoStreamsobject—CognitoIdentityPoolCognitoStreams is a nested property type of AWS::Cognito::IdentityPool.
cognitoStreams.roleArnstring—
cognitoStreams.streamNamestring—
cognitoStreams.streamingStatusstring—
developerProviderNamestring—
identityPoolNamestring—
identityPoolTagsarray<object>—An array of key-value pairs to apply to this resource.
identityPoolTags[].keystringyes
identityPoolTags[].valuestringyes
openIdConnectProviderARNsarray<string>—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
pushSyncobject—CognitoIdentityPoolPushSync is a nested property type of AWS::Cognito::IdentityPool.
pushSync.applicationArnsarray<string>—
pushSync.roleArnstring—
samlProviderARNsarray<string>—
supportedLoginProvidersobject—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
namestring—Read-only: reported by AWS after creation.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
identityPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
identityProviderNamestringyesCreate-only in AWS: changing it requires replacing the resource.
principalTagsobject—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
useDefaultsboolean—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
identityPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
roleMappingsobject—
rolesobject—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
logConfigurationsarray<object>—
logConfigurations[].cloudWatchLogsConfigurationobject—CognitoLogDeliveryConfigurationCloudWatchLogsConfiguration is a nested property type of AWS::Cognito::LogDeliveryConfiguration.
logConfigurations[].cloudWatchLogsConfiguration.logGroupArnstring—
logConfigurations[].eventSourcestring—
logConfigurations[].firehoseConfigurationobject—CognitoLogDeliveryConfigurationFirehoseConfiguration is a nested property type of AWS::Cognito::LogDeliveryConfiguration.
logConfigurations[].firehoseConfiguration.streamArnstring—
logConfigurations[].logLevelstring—
logConfigurations[].s3Configurationobject—CognitoLogDeliveryConfigurationS3Configuration is a nested property type of AWS::Cognito::LogDeliveryConfiguration.
logConfigurations[].s3Configuration.bucketArnstring—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
assetsarray<object>—
assets[].bytesstring—
assets[].categoryenumyesAllowed: FAVICON_ICO, FAVICON_SVG, EMAIL_GRAPHIC, SMS_GRAPHIC, AUTH_APP_GRAPHIC, PASSWORD_GRAPHIC, PASSKEY_GRAPHIC, PAGE_HEADER_LOGO…
assets[].colorModeenumyesAllowed: LIGHT, DARK, DYNAMIC
assets[].extensionenumyesAllowed: ICO, JPEG, PNG, SVG, WEBP
assets[].resourceIdstring—
clientIdstring—Create-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
returnMergedResourcesboolean—
settingsobject—
useCognitoProvidedValuesboolean—
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
managedLoginBrandingIdstring—Read-only: reported by AWS after creation.
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
clientIdstring—Create-only in AWS: changing it requires replacing the resource.
enforcementenumyesAllowed: NONE
linksmap<string>yes
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
termsNamestringyes
termsSourceenumyesAllowed: LINK
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
termsIdstring—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

FieldTypeRequiredDescription
customDomainConfigobject—CognitoUserPoolDomainCustomDomainConfigType is a nested property type of AWS::Cognito::UserPoolDomain.
customDomainConfig.certificateArnstring—
customDomainConfig.securityPolicystring—
domainstringyesCreate-only in AWS: changing it requires replacing the resource.
managedLoginVersioninteger—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
routingobject—CognitoUserPoolDomainRoutingType is a nested property type of AWS::Cognito::UserPoolDomain.
routing.failoverobject—CognitoUserPoolDomainFailoverType is a nested property type of AWS::Cognito::UserPoolDomain.
routing.failover.primaryRoute53HealthCheckIdstringyes
routing.failover.secondaryRegionstringyes
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
cloudFrontDistributionstring—Read-only: reported by AWS after creation.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
descriptionstring—
groupNamestring—Create-only in AWS: changing it requires replacing the resource.
precedenceinteger—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
roleArnstring—
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
attributeMappingmap<string>—
idpIdentifiersarray<string>—
providerDetailsmap<string>yes
providerNamestringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
providerTypestringyesCreate-only in AWS: changing it requires replacing the resource.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
emailConfigurationobject—CognitoUserPoolRegionalConfigurationAttachmentEmailConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
emailConfiguration.configurationSetstring—
emailConfiguration.emailSendingAccountstring—
emailConfiguration.fromstring—
emailConfiguration.replyToEmailAddressstring—
emailConfiguration.sourceArnstring—
lambdaConfigobject—CognitoUserPoolRegionalConfigurationAttachmentLambdaConfig is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
lambdaConfig.createAuthChallengestring—
lambdaConfig.customEmailSenderobject—CognitoUserPoolRegionalConfigurationAttachmentCustomEmailSender is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
lambdaConfig.customEmailSender.lambdaArnstring—
lambdaConfig.customEmailSender.lambdaVersionstring—
lambdaConfig.customMessagestring—
lambdaConfig.customSMSSenderobject—CognitoUserPoolRegionalConfigurationAttachmentCustomSMSSender is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
lambdaConfig.customSMSSender.lambdaArnstring—
lambdaConfig.customSMSSender.lambdaVersionstring—
lambdaConfig.defineAuthChallengestring—
lambdaConfig.inboundFederationobject—CognitoUserPoolRegionalConfigurationAttachmentInboundFederation is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
lambdaConfig.inboundFederation.lambdaArnstring—
lambdaConfig.inboundFederation.lambdaVersionstring—
lambdaConfig.kmsKeyIDstring—
lambdaConfig.postAuthenticationstring—
lambdaConfig.postConfirmationstring—
lambdaConfig.preAuthenticationstring—
lambdaConfig.preSignUpstring—
lambdaConfig.preTokenGenerationstring—
lambdaConfig.preTokenGenerationConfigobject—CognitoUserPoolRegionalConfigurationAttachmentPreTokenGenerationConfig is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
lambdaConfig.preTokenGenerationConfig.lambdaArnstring—
lambdaConfig.preTokenGenerationConfig.lambdaVersionstring—
lambdaConfig.userMigrationstring—
lambdaConfig.verifyAuthChallengeResponsestring—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
smsConfigurationobject—CognitoUserPoolRegionalConfigurationAttachmentSmsConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
smsConfiguration.eumsSmsobject—CognitoUserPoolRegionalConfigurationAttachmentEumsSmsConfiguration is a nested property type of AWS::Cognito::UserPoolRegionalConfigurationAttachment.
smsConfiguration.eumsSms.callerArnstringyes
smsConfiguration.eumsSms.configurationSetNamestring—
smsConfiguration.eumsSms.externalIdstring—
smsConfiguration.eumsSms.inEntityIdstring—
smsConfiguration.eumsSms.inTemplateIdstring—
smsConfiguration.eumsSms.originationIdentitystring—
smsConfiguration.eumsSms.regionstring—
smsConfiguration.externalIdstring—
smsConfiguration.snsCallerArnstring—
smsConfiguration.snsRegionstring—
statusstring—The status of the replica.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
userPoolTagsmap<string>—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
regionNamestringyesCreate-only in AWS: changing it requires replacing the resource.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
userPoolTagsAtCreatemap<string>—Create-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
identifierstringyesCreate-only in AWS: changing it requires replacing the resource.
namestringyes
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
scopesarray<object>—
scopes[].scopeDescriptionstringyes
scopes[].scopeNamestringyes
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
accountTakeoverRiskConfigurationobject—CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.actionsobjectyesCognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionsType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.actions.highActionobject—CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.actions.highAction.eventActionstringyes
accountTakeoverRiskConfiguration.actions.highAction.notifybooleanyes
accountTakeoverRiskConfiguration.actions.lowActionobject—CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.actions.lowAction.eventActionstringyes
accountTakeoverRiskConfiguration.actions.lowAction.notifybooleanyes
accountTakeoverRiskConfiguration.actions.mediumActionobject—CognitoUserPoolRiskConfigurationAttachmentAccountTakeoverActionType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.actions.mediumAction.eventActionstringyes
accountTakeoverRiskConfiguration.actions.mediumAction.notifybooleanyes
accountTakeoverRiskConfiguration.notifyConfigurationobject—CognitoUserPoolRiskConfigurationAttachmentNotifyConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmailobject—CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.htmlBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.subjectstringyes
accountTakeoverRiskConfiguration.notifyConfiguration.blockEmail.textBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.fromstring—
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmailobject—CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.htmlBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.subjectstringyes
accountTakeoverRiskConfiguration.notifyConfiguration.mfaEmail.textBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmailobject—CognitoUserPoolRiskConfigurationAttachmentNotifyEmailType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.htmlBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.subjectstringyes
accountTakeoverRiskConfiguration.notifyConfiguration.noActionEmail.textBodystring—
accountTakeoverRiskConfiguration.notifyConfiguration.replyTostring—
accountTakeoverRiskConfiguration.notifyConfiguration.sourceArnstringyes
clientIdstringyesCreate-only in AWS: changing it requires replacing the resource.
compromisedCredentialsRiskConfigurationobject—CognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
compromisedCredentialsRiskConfiguration.actionsobjectyesCognitoUserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
compromisedCredentialsRiskConfiguration.actions.eventActionstringyes
compromisedCredentialsRiskConfiguration.eventFilterarray<string>—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
riskExceptionConfigurationobject—CognitoUserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType is a nested property type of AWS::Cognito::UserPoolRiskConfigurationAttachment.
riskExceptionConfiguration.blockedIPRangeListarray<string>—
riskExceptionConfiguration.skippedIPRangeListarray<string>—
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
clientIdstringyesCreate-only in AWS: changing it requires replacing the resource.
cssstring—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
clientMetadatamap<string>—Create-only in AWS: changing it requires replacing the resource.
desiredDeliveryMediumsarray<string>—Create-only in AWS: changing it requires replacing the resource.
forceAliasCreationboolean—Create-only in AWS: changing it requires replacing the resource.
messageActionstring—Create-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
userAttributesarray<object>—Create-only in AWS: changing it requires replacing the resource.
userAttributes[].namestring—
userAttributes[].valuestring—
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
usernamestring—Create-only in AWS: changing it requires replacing the resource.
validationDataarray<object>—Create-only in AWS: changing it requires replacing the resource.
validationData[].namestring—
validationData[].valuestring—

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
groupNamestringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
userPoolIdstringyesCreate-only in AWS: changing it requires replacing the resource.
usernamestringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
attributeMappingmap<string>—AttributeMapping maps provider attributes to user pool attributes.
idpIdentifiersarray<string>—IdpIdentifiers are alternative identifiers for the IdP.
providerDetailsmap<string>yesProviderDetails are the provider-specific settings.
providerNamestringyesProviderName is the identity provider name.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
providerTypeenumyesProviderType is the identity provider type. Allowed: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
userPoolRefobjectyesUserPoolRef references the user pool.
userPoolRef.namestring—Name of a UserPool CR in the same namespace.
userPoolRef.userPoolIdstring—UserPoolID is a direct AWS Cognito user pool ID.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—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

FieldTypeRequiredDescription
autoVerifiedAttributesarray<string>—AutoVerifiedAttributes are the attributes to auto-verify (email, phone_number).
mfaConfigurationenum—MfaConfiguration sets MFA. Allowed: OFF, ON, OPTIONAL
passwordPolicyobject—PasswordPolicy defines the password policy.
passwordPolicy.minimumLengthinteger—MinimumLength is the minimum password length.
passwordPolicy.requireLowercaseboolean—RequireLowercase requires lowercase letters.
passwordPolicy.requireNumbersboolean—RequireNumbers requires numbers.
passwordPolicy.requireSymbolsboolean—RequireSymbols requires symbols.
passwordPolicy.requireUppercaseboolean—RequireUppercase requires uppercase letters.
poolNamestringyesPoolName is the name of the user pool.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the ARN of the user pool.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
userPoolIdstring—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

FieldTypeRequiredDescription
accessTokenValidityinteger—AccessTokenValidity is the access token validity in minutes (1-86400).
allowedOAuthFlowsarray<string>—AllowedOAuthFlows are the allowed OAuth flows.
allowedOAuthScopesarray<string>—AllowedOAuthScopes are the allowed OAuth scopes.
callbackUrlsarray<string>—CallbackURLs are the allowed callback URLs.
clientNamestringyesClientName is the name of the app client.
explicitAuthFlowsarray<string>—ExplicitAuthFlows are the authentication flows to allow.
generateSecretboolean—GenerateSecret generates a client secret.
idTokenValidityinteger—IdTokenValidity is the ID token validity in minutes (1-86400).
logoutUrlsarray<string>—LogoutURLs are the allowed sign-out URLs.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
refreshTokenValidityinteger—RefreshTokenValidity is the refresh token validity in days (1-3650).
supportedIdentityProvidersarray<string>—SupportedIdentityProviders are the supported identity providers.
userPoolRefobjectyesUserPoolRef references the user pool.
userPoolRef.namestring—Name of a UserPool CR in the same namespace.
userPoolRef.userPoolIdstring—UserPoolID is a direct AWS Cognito user pool ID.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
clientIdstring—ClientID is the AWS Cognito app client ID.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.