RDS & Aurora

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

API Group: aws.konfig.io/v1alpha1

DBCluster # GA

DBCluster is the Schema for managing Aurora DB Clusters.

kubectl get dbclusters · example on GitHub

Example

# DBCluster — RDS & Aurora
# 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/rds.html#dbcluster
apiVersion: aws.konfig.io/v1alpha1
kind: DBCluster
metadata:
  name: example-dbcluster
  namespace: default
spec:
  allocatedStorage: 1
  autoMinorVersionUpgrade: false
  backtrackWindow: 1
  backupRetentionPeriod: 1
  copyTagsToSnapshot: false
  dbClusterIdentifier: example
  dbClusterParameterGroupRef: example
  dbSubnetGroupRef: example
  deletionProtection: true
  enableHttpEndpoint: true
  enableIAMDatabaseAuthentication: true
  enabledCloudwatchLogsExports:
  - example
  engine: aurora-mysql
  engineMode: provisioned
  engineVersion: example
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  masterUserPasswordRef:
    key: example
    name: example-dbcluster
  masterUsername: example-dbcluster
  networkType: IPV4
  performanceInsightsEnabled: true
  performanceInsightsKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  performanceInsightsRetentionPeriod: 7
  port: 443
  preferredBackupWindow: example
  preferredMaintenanceWindow: example
  providerRef:
    name: example-dbcluster
    region: us-east-1
  serverlessV2ScalingConfig:
    maxCapacity: 2
    minCapacity: 2
  skipFinalSnapshot: false
  storageEncrypted: true
  storageType: example
  tags:
    environment: dev
    team: platform
  vpcSecurityGroupRefs:
  - name: example-vpcsecuritygrouprefs

Spec

Field	Type	Required	Description
`allocatedStorage`	integer	—	AllocatedStorage is the storage size in GiB (required for Aurora I/O-Optimized).
`autoMinorVersionUpgrade`	boolean	—	AutoMinorVersionUpgrade enables automatic minor version upgrades during the maintenance window.
`backtrackWindow`	integer	—	BacktrackWindow is the backtrack window in seconds for Aurora MySQL.
`backupRetentionPeriod`	integer	—	BackupRetentionPeriod is the number of days to retain automated backups.
`copyTagsToSnapshot`	boolean	—	CopyTagsToSnapshot copies tags to automated DB snapshots.
`dbClusterIdentifier`	string	yes	DBClusterIdentifier is the unique name for the DB cluster.
`dbClusterParameterGroupRef`	string	—	DBClusterParameterGroupRef is the name of a DBClusterParameterGroup CR in the same namespace.
`dbSubnetGroupRef`	string	—	DBSubnetGroupRef is the name of a DBSubnetGroup CR in the same namespace.
`deletionProtection`	boolean	—	DeletionProtection prevents the cluster from being deleted.
`enableHttpEndpoint`	boolean	—	EnableHttpEndpoint enables the Data API for Aurora Serverless.
`enableIAMDatabaseAuthentication`	boolean	—	EnableIAMDatabaseAuthentication enables IAM database authentication.
`enabledCloudwatchLogsExports`	array<string>	—	EnabledCloudwatchLogsExports is the list of log types to export to CloudWatch.
`engine`	enum	yes	Engine is the Aurora engine (aurora-mysql or aurora-postgresql). Allowed: `aurora-mysql, aurora-postgresql`
`engineMode`	enum	—	EngineMode is the DB engine mode: provisioned, serverless, or parallelquery. Allowed: `provisioned, serverless, parallelquery, global, multimaster`
`engineVersion`	string	—	EngineVersion is the version of the Aurora engine.
`kmsKeyId`	string	—	KMSKeyID is the KMS key ARN/ID for storage encryption.
`masterUserPasswordRef`	object	yes	MasterUserPasswordRef references a Kubernetes Secret containing the master password.
`masterUserPasswordRef.key`	string	yes	Key is the key within the Secret whose value to use.
`masterUserPasswordRef.name`	string	yes	Name of the Kubernetes Secret.
`masterUsername`	string	yes	MasterUsername is the login for the master user.
`networkType`	enum	—	NetworkType is the network type: IPV4 or DUAL. Allowed: `IPV4, DUAL`
`performanceInsightsEnabled`	boolean	—	PerformanceInsightsEnabled enables Performance Insights for cluster instances.
`performanceInsightsKmsKeyId`	string	—	PerformanceInsightsKMSKeyID is the KMS key ARN/ID for Performance Insights encryption.
`performanceInsightsRetentionPeriod`	integer	—	PerformanceInsightsRetentionPeriod is the number of days to retain Performance Insights data.
`port`	integer	—	Port is the port the cluster listens on.
`preferredBackupWindow`	string	—	PreferredBackupWindow is the daily time range for automated backups (e.g.
`preferredMaintenanceWindow`	string	—	PreferredMaintenanceWindow is the weekly time range for maintenance (e.g.
`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.
`serverlessV2ScalingConfig`	object	—	ServerlessV2ScalingConfig defines the capacity range for Aurora Serverless v2.
`serverlessV2ScalingConfig.maxCapacity`	number	yes	MaxCapacity is the maximum Aurora capacity units (ACUs).
`serverlessV2ScalingConfig.minCapacity`	number	yes	MinCapacity is the minimum Aurora capacity units (ACUs).
`skipFinalSnapshot`	boolean	—	SkipFinalSnapshot skips the final snapshot when the cluster is deleted.
`storageEncrypted`	boolean	—	StorageEncrypted enables encryption at rest.
`storageType`	string	—	StorageType is the storage type (aurora, aurora-iopt1).
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`vpcSecurityGroupRefs`	array<object>	—	VPCSecurityGroupRefs is the list of VPC security group references.
`vpcSecurityGroupRefs[].id`	string	—	ID is a direct AWS Security Group ID (e.g.
`vpcSecurityGroupRefs[].name`	string	—	Name of a SecurityGroup CR in the same namespace.

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.
`dbClusterArn`	string	—	DBClusterARN is the Amazon Resource Name of the DB cluster.
`endpoint`	string	—	Endpoint is the writer endpoint hostname.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`readerEndpoint`	string	—	ReaderEndpoint is the reader endpoint hostname.
`status`	string	—	Status is the current cluster status (available, creating, modifying, deleting, etc.).

DBClusterParameterGroup # GA

DBClusterParameterGroup is the Schema for managing RDS Aurora Cluster Parameter Groups.

kubectl get dbclusterparametergroups · example on GitHub

Example

# DBClusterParameterGroup — RDS & Aurora
# 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/rds.html#dbclusterparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: DBClusterParameterGroup
metadata:
  name: example-dbclusterparametergroup
  namespace: default
spec:
  dbClusterParameterGroupName: example-dbclusterparametergroup
  dbParameterGroupFamily: example
  description: Managed by konfig-konector
  parameters:
  - applyMethod: immediate
    parameterName: example-dbclusterparametergroup
    parameterValue: example
  providerRef:
    name: example-dbclusterparametergroup
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`dbClusterParameterGroupName`	string	yes	DBClusterParameterGroupName is the name of the cluster parameter group.
`dbParameterGroupFamily`	string	yes	DBParameterGroupFamily is the Aurora engine family (e.g.
`description`	string	yes	Description is the description for the cluster parameter group.
`parameters`	array<object>	—	Parameters is the list of parameter overrides.
`parameters[].applyMethod`	enum	—	ApplyMethod is "immediate" or "pending-reboot". Allowed: `immediate, pending-reboot`
`parameters[].parameterName`	string	yes	ParameterName is the name of the DB parameter.
`parameters[].parameterValue`	string	yes	ParameterValue is the value of the DB parameter.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the Amazon Resource Name of the DB cluster parameter group.
`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.

DBInstance # GA

DBInstance is the Schema for managing RDS DB Instances.

kubectl get dbinstances · example on GitHub

Example

# DBInstance — RDS & Aurora
# 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/rds.html#dbinstance
apiVersion: aws.konfig.io/v1alpha1
kind: DBInstance
metadata:
  name: example-dbinstance
  namespace: default
spec:
  allocatedStorage: 5
  autoMinorVersionUpgrade: false
  backupRetentionPeriod: 1
  copyTagsToSnapshot: false
  dbInstanceClass: example
  dbInstanceIdentifier: example
  dbName: example-dbinstance
  dbParameterGroupRef: example
  dbSubnetGroupRef: example
  deletionProtection: true
  enableIAMDatabaseAuthentication: true
  enablePerformanceInsights: true
  enabledCloudwatchLogsExports:
  - example
  engine: example
  engineVersion: example
  iops: 1
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  masterUserPasswordRef:
    key: example
    name: example-dbinstance
  masterUsername: example-dbinstance
  maxAllocatedStorage: 1
  monitoringInterval: 1
  monitoringRoleArn: arn:aws:iam::123456789012:role/example-role
  multiAZ: false
  performanceInsightsKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  performanceInsightsRetentionPeriod: 7
  port: 443
  preferredBackupWindow: example
  preferredMaintenanceWindow: example
  providerRef:
    name: example-dbinstance
    region: us-east-1
  publiclyAccessible: false
  skipFinalSnapshot: false
  storageEncrypted: true
  storageThroughput: 1
  storageType: gp2
  tags:
    environment: dev
    team: platform
  vpcSecurityGroupRefs:
  - name: example-vpcsecuritygrouprefs

Spec

Field	Type	Required	Description
`allocatedStorage`	integer	yes	AllocatedStorage is the storage size in GiB.
`autoMinorVersionUpgrade`	boolean	—	AutoMinorVersionUpgrade enables automatic minor version upgrades during the maintenance window.
`backupRetentionPeriod`	integer	—	BackupRetentionPeriod is the number of days to retain automated backups (0 to disable).
`copyTagsToSnapshot`	boolean	—	CopyTagsToSnapshot copies tags to automated DB snapshots.
`dbInstanceClass`	string	yes	DBInstanceClass is the compute and memory capacity (e.g.
`dbInstanceIdentifier`	string	yes	DBInstanceIdentifier is the unique name for the DB instance.
`dbName`	string	—	DBName is the name of the initial database.
`dbParameterGroupRef`	string	—	DBParameterGroupRef is the name of a DBParameterGroup CR in the same namespace.
`dbSubnetGroupRef`	string	—	DBSubnetGroupRef is the name of a DBSubnetGroup CR in the same namespace.
`deletionProtection`	boolean	—	DeletionProtection prevents the DB instance from being deleted.
`enableIAMDatabaseAuthentication`	boolean	—	EnableIAMDatabaseAuthentication enables IAM database authentication.
`enablePerformanceInsights`	boolean	—	EnablePerformanceInsights enables Performance Insights for the DB instance.
`enabledCloudwatchLogsExports`	array<string>	—	EnabledCloudwatchLogsExports is the list of log types to export to CloudWatch.
`engine`	string	yes	Engine is the database engine (e.g.
`engineVersion`	string	—	EngineVersion is the version of the database engine.
`iops`	integer	—	Iops is the I/O operations per second for io1/io2 storage.
`kmsKeyId`	string	—	KMSKeyID is the KMS key ARN/ID for storage encryption.
`masterUserPasswordRef`	object	yes	MasterUserPasswordRef references a Kubernetes Secret containing the master password.
`masterUserPasswordRef.key`	string	yes	Key is the key within the Secret whose value to use.
`masterUserPasswordRef.name`	string	yes	Name of the Kubernetes Secret.
`masterUsername`	string	yes	MasterUsername is the login name for the master user.
`maxAllocatedStorage`	integer	—	MaxAllocatedStorage enables storage autoscaling up to this size in GiB.
`monitoringInterval`	integer	—	MonitoringInterval is the interval in seconds for Enhanced Monitoring metrics (0, 1, 5, 10, 15, 30, 60).
`monitoringRoleArn`	string	—	MonitoringRoleARN is the IAM role ARN for Enhanced Monitoring.
`multiAZ`	boolean	—	MultiAZ enables a Multi-AZ deployment.
`performanceInsightsKmsKeyId`	string	—	PerformanceInsightsKMSKeyID is the KMS key ARN/ID for Performance Insights encryption.
`performanceInsightsRetentionPeriod`	integer	—	PerformanceInsightsRetentionPeriod is the number of days to retain Performance Insights data (7 or 731).
`port`	integer	—	Port is the port the DB listens on.
`preferredBackupWindow`	string	—	PreferredBackupWindow is the daily time range for automated backups (e.g.
`preferredMaintenanceWindow`	string	—	PreferredMaintenanceWindow is the weekly time range for maintenance (e.g.
`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.
`publiclyAccessible`	boolean	—	PubliclyAccessible controls whether the DB is publicly accessible.
`skipFinalSnapshot`	boolean	—	SkipFinalSnapshot skips the final snapshot when the instance is deleted.
`storageEncrypted`	boolean	—	StorageEncrypted enables encryption at rest.
`storageThroughput`	integer	—	StorageThroughput is the storage throughput in MiB/s for gp3 storage.
`storageType`	enum	—	StorageType is the storage type: gp2, gp3, or io1. Allowed: `gp2, gp3, io1, standard`
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`vpcSecurityGroupRefs`	array<object>	—	VPCSecurityGroupRefs is the list of VPC security group references.
`vpcSecurityGroupRefs[].id`	string	—	ID is a direct AWS Security Group ID (e.g.
`vpcSecurityGroupRefs[].name`	string	—	Name of a SecurityGroup CR in the same namespace.

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.
`dbInstanceArn`	string	—	DBInstanceARN is the Amazon Resource Name of the DB instance.
`dbInstanceStatus`	string	—	DBInstanceStatus is the current status (available, creating, modifying, deleting, etc.).
`endpoint`	string	—	Endpoint is the connection endpoint hostname.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`port`	integer	—	Port is the connection port.

DBOptionGroup # GA

DBOptionGroup is the Schema for managing RDS DB Option Groups.

kubectl get dboptiongroups · example on GitHub

Example

# DBOptionGroup — RDS & Aurora
# 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/rds.html#dboptiongroup
apiVersion: aws.konfig.io/v1alpha1
kind: DBOptionGroup
metadata:
  name: example-dboptiongroup
  namespace: default
spec:
  engineName: example-dboptiongroup
  majorEngineVersion: example
  optionGroupDescription: Managed by konfig-konector
  optionGroupName: example-dboptiongroup
  options:
  - optionName: example-dboptiongroup
    optionSettings:
    - name: example-dboptiongroup
      value: example
    port: 443
  providerRef:
    name: example-dboptiongroup
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`engineName`	string	yes	EngineName is the DB engine (e.g.
`majorEngineVersion`	string	yes	MajorEngineVersion is the engine version (e.g.
`optionGroupDescription`	string	yes	OptionGroupDescription is a description for the option group.
`optionGroupName`	string	yes	OptionGroupName is the name of the option group.
`options`	array<object>	—	Options are the options to include in the group.
`options[].optionName`	string	yes	OptionName is the name of the option (e.g.
`options[].optionSettings`	array<object>	—	OptionSettings are additional settings for the option.
`options[].optionSettings[].name`	string	yes	Name of the setting.
`options[].optionSettings[].value`	string	yes	Value of the setting.
`options[].port`	integer	—	Port is the port number for the option.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the option group.
`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.

DBParameterGroup # GA

DBParameterGroup is the Schema for managing RDS DB Parameter Groups.

kubectl get dbparametergroups · example on GitHub

Example

# DBParameterGroup — RDS & Aurora
# 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/rds.html#dbparametergroup
apiVersion: aws.konfig.io/v1alpha1
kind: DBParameterGroup
metadata:
  name: example-dbparametergroup
  namespace: default
spec:
  dbParameterGroupFamily: example
  dbParameterGroupName: example-dbparametergroup
  description: Managed by konfig-konector
  parameters:
  - applyMethod: immediate
    parameterName: example-dbparametergroup
    parameterValue: example
  providerRef:
    name: example-dbparametergroup
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`dbParameterGroupFamily`	string	yes	DBParameterGroupFamily is the DB engine family (e.g.
`dbParameterGroupName`	string	yes	DBParameterGroupName is the name of the parameter group.
`description`	string	yes	Description is the description for the parameter group.
`parameters`	array<object>	—	Parameters is the list of parameter overrides.
`parameters[].applyMethod`	enum	—	ApplyMethod is "immediate" or "pending-reboot". Allowed: `immediate, pending-reboot`
`parameters[].parameterName`	string	yes	ParameterName is the name of the DB parameter.
`parameters[].parameterValue`	string	yes	ParameterValue is the value of the DB parameter.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the Amazon Resource Name of the DB parameter group.
`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.

DBProxy # GA

DBProxy is the Schema for managing RDS DB Proxies.

kubectl get dbproxies · example on GitHub

Example

# DBProxy — RDS & Aurora
# 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/rds.html#dbproxy
apiVersion: aws.konfig.io/v1alpha1
kind: DBProxy
metadata:
  name: example-dbproxy
  namespace: default
spec:
  auth:
  - authScheme: example
    description: Managed by konfig-konector
    iamAuth: DISABLED
    secretArn: arn:aws:iam::123456789012:role/example-role
  dbProxyName: example-dbproxy
  debugLogging: false
  engineFamily: MYSQL
  idleClientTimeout: 300
  providerRef:
    name: example-dbproxy
    region: us-east-1
  requireTls: false
  roleArn: arn:aws:iam::123456789012:role/example-role
  tags:
    environment: dev
    team: platform
  vpcSecurityGroupIds:
  - example
  vpcSubnetIds:
  - example

Spec

Field	Type	Required	Description
`auth`	array<object>	yes	Auth is the authorization configuration for the proxy.
`auth[].authScheme`	string	—	AuthScheme is the authentication scheme (SECRETS).
`auth[].description`	string	—	Description is an optional description of this auth config.
`auth[].iamAuth`	enum	—	IAMAuth enables or disables IAM authentication. Allowed: `DISABLED, REQUIRED, ALLOWED`
`auth[].secretArn`	string	—	SecretARN is the ARN of the Secrets Manager secret holding the credentials.
`dbProxyName`	string	yes	DBProxyName is the name of the proxy.
`debugLogging`	boolean	—	DebugLogging enables enhanced logging for the proxy.
`engineFamily`	enum	yes	EngineFamily is the database engine family (MYSQL or POSTGRESQL). Allowed: `MYSQL, POSTGRESQL, SQLSERVER`
`idleClientTimeout`	integer	—	IdleClientTimeout is the number of seconds a connection can be inactive before being closed.
`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.
`requireTls`	boolean	—	RequireTLS requires TLS for all connections to the proxy.
`roleArn`	string	yes	RoleARN is the ARN of the IAM role the proxy uses to access Secrets Manager.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`vpcSecurityGroupIds`	array<string>	—	VPCSecurityGroupIDs are optional security groups for the proxy.
`vpcSubnetIds`	array<string>	yes	VPCSubnetIDs are the VPC subnet IDs for the proxy.

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.
`dbProxyArn`	string	—	DBProxyARN is the ARN of the RDS proxy.
`endpoint`	string	—	Endpoint is the proxy endpoint for client connections.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`status`	string	—	Status is the current state of the proxy.

DBSnapshot # GA

DBSnapshot is the Schema for managing RDS DB Snapshots.

kubectl get dbsnapshots · example on GitHub

Example

# DBSnapshot — RDS & Aurora
# 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/rds.html#dbsnapshot
apiVersion: aws.konfig.io/v1alpha1
kind: DBSnapshot
metadata:
  name: example-dbsnapshot
  namespace: default
spec:
  dbInstanceIdentifier: example
  dbSnapshotIdentifier: example
  providerRef:
    name: example-dbsnapshot
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`dbInstanceIdentifier`	string	yes	DBInstanceIdentifier is the identifier of the RDS instance to snapshot.
`dbSnapshotIdentifier`	string	yes	DBSnapshotIdentifier is the identifier for this snapshot.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`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.
`snapshotArn`	string	—	SnapshotARN is the ARN of the snapshot.
`snapshotStatus`	string	—	SnapshotStatus is the current state of the snapshot.

DBSubnetGroup # GA

DBSubnetGroup is the Schema for managing RDS DB Subnet Groups.

kubectl get dbsubnetgroups · example on GitHub

Example

# DBSubnetGroup — RDS & Aurora
# 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/rds.html#dbsubnetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: DBSubnetGroup
metadata:
  name: example-dbsubnetgroup
  namespace: default
spec:
  dbSubnetGroupName: example-dbsubnetgroup
  description: Managed by konfig-konector
  providerRef:
    name: example-dbsubnetgroup
    region: us-east-1
  subnetRefs:
  - name: example-subnetrefs
  - name: example-subnetrefs
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`dbSubnetGroupName`	string	yes	DBSubnetGroupName is the name of the DB subnet group.
`description`	string	yes	Description is the description 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.
`subnetRefs`	array<object>	yes	SubnetRefs is the list of subnet references to include in the group.
`subnetRefs[].id`	string	—	ID is a direct AWS Subnet ID (e.g.
`subnetRefs[].name`	string	—	Name of a Subnet CR in the same namespace.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the Amazon Resource Name of the DB subnet group.
`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.
`status`	string	—	Status is the current status of the DB subnet group.

RDSClusterSnapshot # CLOUD CONTROL · AWS::RDS::ClusterSnapshot

RDSClusterSnapshot manages AWS::RDS::ClusterSnapshot through the AWS Cloud Control API.

kubectl get rdsclustersnapshots · example on GitHub

Example

# RDSClusterSnapshot — RDS & Aurora
# 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/rds.html#rdsclustersnapshot
apiVersion: aws.konfig.io/v1alpha1
kind: RDSClusterSnapshot
metadata:
  name: example-rdsclustersnapshot
  namespace: default
spec:
  dbClusterIdentifier: example
  dbClusterSnapshotIdentifier: example
  providerRef:
    name: example-rdsclustersnapshot
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`dbClusterIdentifier`	string	yes	The identifier of the DB cluster to create a snapshot for.
`dbClusterSnapshotIdentifier`	string	yes	The identifier for the DB cluster snapshot.
`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>	—	The tags to be assigned to the DB cluster snapshot.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`allocatedStorage`	integer	—	The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`availabilityZones`	array<string>	—	The list of Availability Zones where instances in the DB cluster snapshot can be restored.
`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).
`clusterCreateTime`	string	—	The time when the DB cluster was created, in Universal Coordinated Time (UTC).
`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.
`dbClusterResourceId`	string	—	The resource ID of the DB cluster that this DB cluster snapshot was created from.
`dbClusterSnapshotArn`	string	—	The Amazon Resource Name (ARN) for the DB cluster snapshot.
`engine`	string	—	The name of the database engine for this DB cluster snapshot.
`engineMode`	string	—	The engine mode of the database engine for this DB cluster snapshot.
`engineVersion`	string	—	The version of the database engine for this DB cluster snapshot.
`iamDatabaseAuthenticationEnabled`	boolean	—	Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`kmsKeyId`	string	—	If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
`lastSyncTime`	string	—
`licenseModel`	string	—	The license model information for this DB cluster snapshot.
`masterUsername`	string	—	The master username for this DB cluster snapshot.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`port`	integer	—	The port that the DB cluster was listening on at the time of the snapshot.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`snapshotCreateTime`	string	—	The time when the snapshot was taken, in Universal Coordinated Time (UTC).
`snapshotType`	string	—	The type of the DB cluster snapshot.
`status`	string	—	The status of this DB cluster snapshot.
`storageEncrypted`	boolean	—	Indicates whether the DB cluster snapshot is encrypted.
`vpcId`	string	—	The VPC ID associated with the DB cluster snapshot.

RDSCustomDBEngineVersion # CLOUD CONTROL · AWS::RDS::CustomDBEngineVersion

RDSCustomDBEngineVersion manages AWS::RDS::CustomDBEngineVersion through the AWS Cloud Control API.

kubectl get rdscustomdbengineversions · example on GitHub

Example

# RDSCustomDBEngineVersion — RDS & Aurora
# 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/rds.html#rdscustomdbengineversion
apiVersion: aws.konfig.io/v1alpha1
kind: RDSCustomDBEngineVersion
metadata:
  name: example-rdscustomdbengineversion
  namespace: default
spec:
  databaseInstallationFiles:
  - example
  databaseInstallationFilesS3BucketName: example-rdscustomdbengineversion
  databaseInstallationFilesS3Prefix: example
  description: Managed by konfig-konector
  engine: example
  engineVersion: example
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  manifest: example
  providerRef:
    name: example-rdscustomdbengineversion
    region: us-east-1
  sourceCustomDbEngineVersionIdentifier: example
  status: available
  tags:
  - key: example
    value: example
  useAwsProvidedLatestImage: false

Spec

Field	Type	Required	Description
`databaseInstallationFiles`	array<string>	—	Create-only in AWS: changing it requires replacing the resource.
`databaseInstallationFilesS3BucketName`	string	—	The name of an Amazon S3 bucket that contains database installation files for your CEV.
`databaseInstallationFilesS3Prefix`	string	—	The Amazon S3 directory that contains the database installation files for your CEV.
`description`	string	—	An optional description of your CEV.
`engine`	string	yes	The database engine to use for your custom engine version (CEV).
`engineVersion`	string	yes	The name of your CEV.
`imageId`	string	—	A value that indicates the ID of the AMI.
`kmsKeyId`	string	—	The AWS KMS key identifier for an encrypted CEV.
`manifest`	string	—	The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.
`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.
`sourceCustomDbEngineVersionIdentifier`	string	—	The ARN of a CEV to use as a source for creating a new CEV.
`status`	enum	—	A value that indicates the status of a custom engine version (CEV). Allowed: `available, inactive, inactive-except-restore, pending-validation`
`tags`	array<object>	—	A list of tags.
`tags[].key`	string	yes
`tags[].value`	string	yes
`useAwsProvidedLatestImage`	boolean	—	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

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.
`dbEngineVersionArn`	string	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

RDSDBProxyEndpoint # CLOUD CONTROL · AWS::RDS::DBProxyEndpoint

RDSDBProxyEndpoint manages AWS::RDS::DBProxyEndpoint through the AWS Cloud Control API.

kubectl get rdsdbproxyendpoints · example on GitHub

Example

# RDSDBProxyEndpoint — RDS & Aurora
# 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/rds.html#rdsdbproxyendpoint
apiVersion: aws.konfig.io/v1alpha1
kind: RDSDBProxyEndpoint
metadata:
  name: example-rdsdbproxyendpoint
  namespace: default
spec:
  dbProxyEndpointName: example-rdsdbproxyendpoint
  dbProxyName: example-rdsdbproxyendpoint
  endpointNetworkType: IPV4
  providerRef:
    name: example-rdsdbproxyendpoint
    region: us-east-1
  tags:
  - key: example
    value: example
  targetRole: READ_WRITE
  vpcSecurityGroupIds:
  - example
  vpcSubnetIds:
  - example

Spec

Field	Type	Required	Description
`dbProxyEndpointName`	string	yes	The identifier for the DB proxy endpoint.
`dbProxyName`	string	yes	The identifier for the proxy.
`endpointNetworkType`	enum	—	The network type of the DB proxy endpoint. Allowed: `IPV4, IPV6, DUAL`
`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 optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint.
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetRole`	enum	—	A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. Allowed: `READ_WRITE, READ_ONLY`
`vpcSecurityGroupIds`	array<string>	—	VPC security group IDs to associate with the new DB proxy endpoint.
`vpcSubnetIds`	array<string>	yes	VPC subnet IDs to associate with the new DB proxy endpoint.

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.
`dbProxyEndpointArn`	string	—	The Amazon Resource Name (ARN) for the DB proxy endpoint.
`endpoint`	string	—	The endpoint that you can use to connect to the DB proxy.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`isDefault`	boolean	—	A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
`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.
`vpcId`	string	—	VPC ID to associate with the new DB proxy endpoint.

RDSDBProxyTargetGroup # CLOUD CONTROL · AWS::RDS::DBProxyTargetGroup

RDSDBProxyTargetGroup manages AWS::RDS::DBProxyTargetGroup through the AWS Cloud Control API.

kubectl get rdsdbproxytargetgroups · example on GitHub

Example

# RDSDBProxyTargetGroup — RDS & Aurora
# 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/rds.html#rdsdbproxytargetgroup
apiVersion: aws.konfig.io/v1alpha1
kind: RDSDBProxyTargetGroup
metadata:
  name: example-rdsdbproxytargetgroup
  namespace: default
spec:
  connectionPoolConfigurationInfo:
    connectionBorrowTimeout: 300
    initQuery: example
    maxConnectionsPercent: 1
    maxIdleConnectionsPercent: 1
    sessionPinningFilters:
    - example
  dbClusterIdentifiers:
  - example
  dbInstanceIdentifiers:
  - example
  dbProxyName: example-rdsdbproxytargetgroup
  providerRef:
    name: example-rdsdbproxytargetgroup
    region: us-east-1
  targetGroupName: default

Spec

Field	Type	Required	Description
`connectionPoolConfigurationInfo`	object	—	RDSDBProxyTargetGroupConnectionPoolConfigurationInfoFormat is a nested property type of AWS::RDS::DBProxyTargetGroup.
`connectionPoolConfigurationInfo.connectionBorrowTimeout`	integer	—	The number of seconds for a proxy to wait for a connection to become available in the connection pool.
`connectionPoolConfigurationInfo.initQuery`	string	—	One or more SQL statements for the proxy to run when opening each new database connection.
`connectionPoolConfigurationInfo.maxConnectionsPercent`	integer	—	The maximum size of the connection pool for each target in a target group.
`connectionPoolConfigurationInfo.maxIdleConnectionsPercent`	integer	—	Controls how actively the proxy closes idle database connections in the connection pool.
`connectionPoolConfigurationInfo.sessionPinningFilters`	array<string>	—	Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection.
`dbClusterIdentifiers`	array<string>	—
`dbInstanceIdentifiers`	array<string>	—
`dbProxyName`	string	yes	The identifier for the proxy.
`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.
`targetGroupName`	enum	yes	The identifier for the DBProxyTargetGroup Create-only in AWS: changing it requires replacing the resource. Allowed: `default`

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.
`targetGroupArn`	string	—	The Amazon Resource Name (ARN) representing the target group.

RDSDBShardGroup # CLOUD CONTROL · AWS::RDS::DBShardGroup

RDSDBShardGroup manages AWS::RDS::DBShardGroup through the AWS Cloud Control API.

kubectl get rdsdbshardgroups · example on GitHub

Example

# RDSDBShardGroup — RDS & Aurora
# 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/rds.html#rdsdbshardgroup
apiVersion: aws.konfig.io/v1alpha1
kind: RDSDBShardGroup
metadata:
  name: example-rdsdbshardgroup
  namespace: default
spec:
  computeRedundancy: 1
  dbClusterIdentifier: example
  dbShardGroupIdentifier: example
  maxACU: 1
  minACU: 1
  providerRef:
    name: example-rdsdbshardgroup
    region: us-east-1
  publiclyAccessible: false
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`computeRedundancy`	integer	—	Specifies whether to create standby standby DB data access shard for the DB shard group.
`dbClusterIdentifier`	string	yes	The name of the primary DB cluster for the DB shard group.
`dbShardGroupIdentifier`	string	—	The name of the DB shard group.
`maxACU`	number	yes	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
`minACU`	number	—	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
`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.
`publiclyAccessible`	boolean	—	Specifies whether the DB shard group is publicly accessible.
`tags`	array<object>	—	An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard 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.
`dbShardGroupResourceId`	string	—	Read-only: reported by AWS after creation.
`endpoint`	string	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

RDSDBSnapshot # CLOUD CONTROL · AWS::RDS::DBSnapshot

RDSDBSnapshot manages AWS::RDS::DBSnapshot through the AWS Cloud Control API.

kubectl get rdsdbsnapshots · example on GitHub

Example

# RDSDBSnapshot — RDS & Aurora
# 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/rds.html#rdsdbsnapshot
apiVersion: aws.konfig.io/v1alpha1
kind: RDSDBSnapshot
metadata:
  name: example-rdsdbsnapshot
  namespace: default
spec:
  dbInstanceIdentifier: example
  dbSnapshotIdentifier: example
  providerRef:
    name: example-rdsdbsnapshot
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`dbInstanceIdentifier`	string	yes	The identifier of the DB instance that you want to create the snapshot of.
`dbSnapshotIdentifier`	string	yes	The identifier for the DB snapshot.
`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>	—	The tags to be assigned to the DB snapshot.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`allocatedStorage`	integer	—	The allocated storage size in gibibytes (GiB).
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`availabilityZone`	string	—	The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
`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.
`dbSnapshotArn`	string	—	The Amazon Resource Name (ARN) for the DB snapshot.
`dbiResourceId`	string	—	The identifier for the source DB instance, which is unique to an AWS Region.
`encrypted`	boolean	—	Indicates whether the DB snapshot is encrypted.
`engine`	string	—	The name of the database engine.
`engineVersion`	string	—	The version of the database engine.
`iamDatabaseAuthenticationEnabled`	boolean	—	Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`instanceCreateTime`	string	—	The time when the DB instance was created, in UTC.
`iops`	integer	—	The Provisioned IOPS value of the DB instance at the time of the snapshot.
`kmsKeyId`	string	—	If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
`lastSyncTime`	string	—
`licenseModel`	string	—	License model information for the restored DB instance.
`masterUsername`	string	—	The master username for the DB snapshot.
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`optionGroupName`	string	—	The option group name for the DB snapshot.
`originalSnapshotCreateTime`	string	—	The time of the CreateDBSnapshot operation in UTC.
`port`	integer	—	The port that the database engine was listening on at the time of the snapshot.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`snapshotCreateTime`	string	—	The time when the snapshot was taken, in UTC.
`snapshotType`	string	—	The type of the DB snapshot.
`status`	string	—	The status of this DB snapshot.
`storageThroughput`	integer	—	The storage throughput for the DB snapshot.
`storageType`	string	—	The storage type associated with the DB snapshot.
`vpcId`	string	—	The VPC ID associated with the DB snapshot.

RDSEventSubscription # GA

RDSEventSubscription is the Schema for managing RDS event subscriptions.

kubectl get rdseventsubscriptions · example on GitHub

Example

# RDSEventSubscription — RDS & Aurora
# 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/rds.html#rdseventsubscription
apiVersion: aws.konfig.io/v1alpha1
kind: RDSEventSubscription
metadata:
  name: example-rdseventsubscription
  namespace: default
spec:
  enabled: true
  eventCategories:
  - example
  providerRef:
    name: example-rdseventsubscription
    region: us-east-1
  snsTopicRef:
    name: example-snstopic
  sourceIds:
  - example
  sourceType: example
  subscriptionName: example-rdseventsubscription

Spec

Field	Type	Required	Description
`enabled`	boolean	—	Enabled activates the subscription.
`eventCategories`	array<string>	—	EventCategories to subscribe to (e.g.
`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.
`snsTopicRef`	object	yes	SnsTopicRef references the SNS topic that receives event notifications (by SNSTopic CR name or direct ARN).
`snsTopicRef.arn`	string	—	ARN is a direct SNS topic ARN (bypasses CR lookup).
`snsTopicRef.name`	string	—	Name is the name of an SNSTopic CR in the same namespace.
`sourceIds`	array<string>	—	SourceIds restricts events to specific source identifiers.
`sourceType`	string	—	SourceType of events, e.g.
`subscriptionName`	string	yes	SubscriptionName is the name of the subscription.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the event subscription.
`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.

RDSGlobalCluster # GA

RDSGlobalCluster is the Schema for managing Aurora global clusters.

kubectl get rdsglobalclusters · example on GitHub

Example

# RDSGlobalCluster — RDS & Aurora
# 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/rds.html#rdsglobalcluster
apiVersion: aws.konfig.io/v1alpha1
kind: RDSGlobalCluster
metadata:
  name: example-rdsglobalcluster
  namespace: default
spec:
  deletionProtection: true
  engine: example
  engineVersion: example
  globalClusterIdentifier: example
  providerRef:
    name: example-rdsglobalcluster
    region: us-east-1
  sourceDBClusterIdentifier: example
  storageEncrypted: true

Spec

Field	Type	Required	Description
`deletionProtection`	boolean	—	DeletionProtection prevents the global cluster from being deleted.
`engine`	string	—	Engine is the database engine, e.g.
`engineVersion`	string	—	EngineVersion is the engine version.
`globalClusterIdentifier`	string	yes	GlobalClusterIdentifier is the 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`	string	—	SourceDBClusterIdentifier is the ARN of an existing DB cluster to use as the primary.
`storageEncrypted`	boolean	—	StorageEncrypted enables encrypted storage.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the global cluster.
`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.
`status`	string	—	Status is the current status of the global cluster.

RDSIntegration # CLOUD CONTROL · AWS::RDS::Integration

RDSIntegration manages AWS::RDS::Integration through the AWS Cloud Control API.

kubectl get rdsintegrations · example on GitHub

Example

# RDSIntegration — RDS & Aurora
# 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/rds.html#rdsintegration
apiVersion: aws.konfig.io/v1alpha1
kind: RDSIntegration
metadata:
  name: example-rdsintegration
  namespace: default
spec:
  additionalEncryptionContext:
    key: value
  dataFilter: example
  description: Managed by konfig-konector
  integrationName: example-rdsintegration
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  providerRef:
    name: example-rdsintegration
    region: us-east-1
  sourceArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example
  targetArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`additionalEncryptionContext`	map<string>	—	An optional set of non-secret key–value pairs that contains additional contextual information about the data.
`dataFilter`	string	—	Data filters for the integration.
`description`	string	—	A description of the integration.
`integrationName`	string	—	The name of the integration.
`kmsKeyId`	string	—	The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the integration.
`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.
`sourceArn`	string	yes	The Amazon Resource Name (ARN) of the database to use as the source for replication.
`tags`	array<object>	—	A list of tags.
`tags[].key`	string	yes
`tags[].value`	string	yes
`targetArn`	string	yes	The ARN of the Redshift data warehouse to use as the target for replication.

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.
`createTime`	string	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`integrationArn`	string	—	Read-only: reported by AWS after creation.
`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.