DynamoDB

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

API Group: aws.konfig.io/v1alpha1

DynamoDBBackup # GA

DynamoDBBackup is the Schema for managing DynamoDB on-demand backups.

kubectl get dynamodbbackups · example on GitHub

Example

# DynamoDBBackup — DynamoDB
# 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/dynamodb.html#dynamodbbackup
apiVersion: aws.konfig.io/v1alpha1
kind: DynamoDBBackup
metadata:
  name: example-dynamodbbackup
  namespace: default
spec:
  backupName: example-dynamodbbackup
  providerRef:
    name: example-dynamodbbackup
    region: us-east-1
  tableName: example-dynamodbbackup

Spec

Field	Type	Required	Description
`backupName`	string	yes	BackupName is the name of the backup.
`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.
`tableName`	string	yes	TableName is the name of the DynamoDB table to back up.

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).
`backupArn`	string	—	BackupARN is the ARN of the backup.
`backupStatus`	string	—	BackupStatus is the current status of the backup (CREATING, DELETED, AVAILABLE).
`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.

DynamoDBGlobalTable # GA

DynamoDBGlobalTable is the Schema for managing DynamoDB Global Tables.

kubectl get dynamodbglobaltables · example on GitHub

Example

# DynamoDBGlobalTable — DynamoDB
# 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/dynamodb.html#dynamodbglobaltable
apiVersion: aws.konfig.io/v1alpha1
kind: DynamoDBGlobalTable
metadata:
  name: example-dynamodbglobaltable
  namespace: default
spec:
  providerRef:
    name: example-dynamodbglobaltable
    region: us-east-1
  replicationGroup:
  - regionName: example-dynamodbglobaltable
  tableName: example-dynamodbglobaltable

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.
`replicationGroup`	array<object>	yes	ReplicationGroup defines the regions for the global table.
`replicationGroup[].regionName`	string	yes	RegionName is the AWS region for this replica.
`tableName`	string	yes	TableName is the name of the global table.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the global table.
`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.
`globalTableStatus`	string	—	GlobalTableStatus is the current status.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

DynamoDBTable # GA

DynamoDBTable is the Schema for managing DynamoDB Tables.

kubectl get dynamodbtables · example on GitHub

Example

# DynamoDBTable — DynamoDB
# 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/dynamodb.html#dynamodbtable
apiVersion: aws.konfig.io/v1alpha1
kind: DynamoDBTable
metadata:
  name: example-dynamodbtable
  namespace: default
spec:
  attributeDefinitions:
  - attributeName: example-dynamodbtable
    attributeType: S
  billingMode: PROVISIONED
  keySchema:
  - attributeName: example-dynamodbtable
    keyType: HASH
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  pointInTimeRecovery: false
  providerRef:
    name: example-dynamodbtable
    region: us-east-1
  provisionedThroughput:
    readCapacityUnits: 1
    writeCapacityUnits: 1
  sseEnabled: true
  tableName: example-dynamodbtable
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`attributeDefinitions`	array<object>	yes	AttributeDefinitions define the table attributes.
`attributeDefinitions[].attributeName`	string	yes	AttributeName is the name of the attribute.
`attributeDefinitions[].attributeType`	enum	yes	AttributeType is the data type (S=String, N=Number, B=Binary). Allowed: `S, N, B`
`billingMode`	enum	—	BillingMode is the billing mode. Allowed: `PROVISIONED, PAY_PER_REQUEST`
`keySchema`	array<object>	yes	KeySchema defines the primary key.
`keySchema[].attributeName`	string	yes	AttributeName is the name of the key attribute.
`keySchema[].keyType`	enum	yes	KeyType is HASH or RANGE. Allowed: `HASH, RANGE`
`kmsKeyArn`	string	—	KMSKeyARN is the KMS key ARN for SSE.
`pointInTimeRecovery`	boolean	—	PointInTimeRecovery enables PITR.
`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.
`provisionedThroughput`	object	—	ProvisionedThroughput is required when BillingMode is PROVISIONED.
`provisionedThroughput.readCapacityUnits`	integer	yes	ReadCapacityUnits is the read capacity.
`provisionedThroughput.writeCapacityUnits`	integer	yes	WriteCapacityUnits is the write capacity.
`sseEnabled`	boolean	—	SSEEnabled enables server-side encryption.
`tableName`	string	yes	TableName is the name of the table.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the DynamoDB table.
`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.
`tableStatus`	string	—	TableStatus is the current table status.

DynamoDBTablePolicy # GA

DynamoDBTablePolicy is the Schema for managing DynamoDB resource policies.

kubectl get dynamodbtablepolicies · example on GitHub

Example

# DynamoDBTablePolicy — DynamoDB
# 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/dynamodb.html#dynamodbtablepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: DynamoDBTablePolicy
metadata:
  name: example-dynamodbtablepolicy
  namespace: default
spec:
  policyDocument: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"],
    "Resource": "*"}]}'
  providerRef:
    name: example-dynamodbtablepolicy
    region: us-east-1
  resourceARN: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`policyDocument`	string	yes	PolicyDocument is the JSON policy document.
`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.
`resourceARN`	string	yes	ResourceARN is the ARN of the DynamoDB table or stream to attach the policy to.

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.
`revisionID`	string	—	RevisionID is the policy revision ID.