DocumentDB

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

API Group: aws.konfig.io/v1alpha1

DocDBDBClusterParameterGroup # CLOUD CONTROL · AWS::DocDB::DBClusterParameterGroup

DocDBDBClusterParameterGroup manages AWS::DocDB::DBClusterParameterGroup through the AWS Cloud Control API.

kubectl get docdbdbclusterparametergroups · example on GitHub

Example

# DocDBDBClusterParameterGroup — DocumentDB
# 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/docdb.html#docdbdbclusterparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: DocDBDBClusterParameterGroup
metadata:
  name: example-docdbdbclusterparametergroup
  namespace: default
spec:
  description: Managed by konfig-konector
  family: example
  name: example-docdbdbclusterparametergroup
  providerRef:
    name: example-docdbdbclusterparametergroup
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`description`	string	yes	The description for the DB cluster parameter group.
`family`	string	yes	The DB cluster parameter group family name (e.g.
`name`	string	—	The name of the DB cluster parameter group.
`parameters`	object	yes	An object containing key-value pairs of parameters to set for the DB cluster parameter group.
`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`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

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.

DocDBDBSubnetGroup # CLOUD CONTROL · AWS::DocDB::DBSubnetGroup

DocDBDBSubnetGroup manages AWS::DocDB::DBSubnetGroup through the AWS Cloud Control API.

kubectl get docdbdbsubnetgroups · example on GitHub

Example

# DocDBDBSubnetGroup — DocumentDB
# 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/docdb.html#docdbdbsubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: DocDBDBSubnetGroup
metadata:
  name: example-docdbdbsubnetgroup
  namespace: default
spec:
  dbSubnetGroupDescription: Managed by konfig-konector
  dbSubnetGroupName: example-docdbdbsubnetgroup
  providerRef:
    name: example-docdbdbsubnetgroup
    region: us-east-1
  subnetIds:
  - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`dbSubnetGroupDescription`	string	yes	The description for the subnet group.
`dbSubnetGroupName`	string	—	The name for the db subnet group.
`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.
`subnetIds`	array<string>	yes	One or more subnet IDs to be assigned to the db subnet group.
`tags`	array<object>	—	One or more tags to be assigned to the db subnet group
`tags[].key`	string	yes
`tags[].value`	string	yes

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.

DocDBEventSubscription # CLOUD CONTROL · AWS::DocDB::EventSubscription

DocDBEventSubscription manages AWS::DocDB::EventSubscription through the AWS Cloud Control API.

kubectl get docdbeventsubscriptions · example on GitHub

Example

# DocDBEventSubscription — DocumentDB
# 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/docdb.html#docdbeventsubscription
apiVersion: aws.konfig.io/v1alpha1
kind: DocDBEventSubscription
metadata:
  name: example-docdbeventsubscription
  namespace: default
spec:
  enabled: true
  eventCategories:
  - example
  providerRef:
    name: example-docdbeventsubscription
    region: us-east-1
  snsTopicArn: arn:aws:iam::123456789012:role/example-role
  sourceIds:
  - example
  sourceType: db-instance
  subscriptionName: example-docdbeventsubscription

Spec

Field	Type	Required	Description
`enabled`	boolean	—	A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
`eventCategories`	array<string>	—	A list of event categories for a SourceType that you want to subscribe to.
`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.
`snsTopicArn`	string	yes	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
`sourceIds`	array<string>	—	The list of identifiers of the event sources for which events are returned
`sourceType`	enum	—	The type of source that is generating the events. Allowed: `db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot`
`subscriptionName`	string	—	The name of the subscription.

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.

DocDBGlobalCluster # CLOUD CONTROL · AWS::DocDB::GlobalCluster

DocDBGlobalCluster manages AWS::DocDB::GlobalCluster through the AWS Cloud Control API.

kubectl get docdbglobalclusters · example on GitHub

Example

# DocDBGlobalCluster — DocumentDB
# 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/docdb.html#docdbglobalcluster
apiVersion: aws.konfig.io/v1alpha1
kind: DocDBGlobalCluster
metadata:
  name: example-docdbglobalcluster
  namespace: default
spec:
  deletionProtection: true
  engine: docdb
  engineVersion: example
  globalClusterIdentifier: example
  providerRef:
    name: example-docdbglobalcluster
    region: us-east-1
  storageEncrypted: true
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`deletionProtection`	boolean	—	Indicates whether the global cluster has deletion protection enabled.
`engine`	enum	—	The database engine to use for this global cluster. Allowed: `docdb`
`engineVersion`	string	—	The engine version to use for this global cluster.
`globalClusterIdentifier`	string	yes	The cluster identifier of the global cluster.
`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.
`sourceDBClusterIdentifier`	object	—	The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
`storageEncrypted`	boolean	—	Indicates whether the global cluster has storage encryption enabled.
`tags`	array<object>	—	The tags to be assigned to the Amazon DocumentDB resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

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.
`globalClusterArn`	string	—	The Amazon Resource Name (ARN) for the global cluster.
`globalClusterResourceId`	string	—	The AWS Region-unique, immutable identifier for the global database cluster.
`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.