Redshift Serverless

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

API Group: aws.konfig.io/v1alpha1

RedshiftServerlessNamespace # CLOUD CONTROL · AWS::RedshiftServerless::Namespace

RedshiftServerlessNamespace manages AWS::RedshiftServerless::Namespace through the AWS Cloud Control API.

kubectl get redshiftserverlessnamespaces · example on GitHub

Example

# RedshiftServerlessNamespace — Redshift Serverless
# 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/redshiftserverless.html#redshiftserverlessnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: RedshiftServerlessNamespace
metadata:
  name: example-redshiftserverlessnamespace
  namespace: default
spec:
  adminPasswordSecretKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  adminUserPassword: example
  adminUsername: example-redshiftserverlessnamespace
  dbName: example-redshiftserverlessnamespace
  defaultIamRoleArn: arn:aws:iam::123456789012:role/example-role
  finalSnapshotName: example-redshiftserverlessnamespace
  finalSnapshotRetentionPeriod: 7
  iamRoles:
  - example
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  logExports:
  - example
  manageAdminPassword: false
  namespaceName: example-redshiftserverlessnamespace
  providerRef:
    name: example-redshiftserverlessnamespace
    region: us-east-1
  redshiftIdcApplicationArn: arn:aws:iam::123456789012:role/example-role
  snapshotCopyConfigurations:
  - destinationKmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
    destinationRegion: example
    snapshotRetentionPeriod: 7
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`adminPasswordSecretKmsKeyId`	string	—	The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
`adminUserPassword`	string	—	The password associated with the admin user for the namespace that is being created.
`adminUsername`	string	—	The user name associated with the admin user for the namespace that is being created.
`dbName`	string	—	The database name associated for the namespace that is being created.
`defaultIamRoleArn`	string	—	The default IAM role ARN for the namespace that is being created.
`finalSnapshotName`	string	—	The name of the namespace the source snapshot was created from.
`finalSnapshotRetentionPeriod`	integer	—	The number of days to retain automated snapshot in the destination region after they are copied from the source region.
`iamRoles`	array<string>	—	A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services.
`kmsKeyId`	string	—	The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace.
`logExports`	array<string>	—	The collection of log types to be exported provided by the customer.
`manageAdminPassword`	boolean	—	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
`namespaceName`	string	yes	A unique identifier for the namespace.
`namespaceResourcePolicy`	object	—	The resource policy document that will be attached to the namespace.
`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.
`redshiftIdcApplicationArn`	string	—	The ARN for the Redshift application that integrates with IAM Identity Center.
`snapshotCopyConfigurations`	array<object>	—	The snapshot copy configurations for the namespace.
`snapshotCopyConfigurations[].destinationKmsKeyId`	string	—
`snapshotCopyConfigurations[].destinationRegion`	string	yes
`snapshotCopyConfigurations[].snapshotRetentionPeriod`	integer	—
`tags`	array<object>	—	The list of tags for the namespace.
`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	—
`namespace`	object	—	Definition of Namespace resource.
`namespace.adminPasswordSecretArn`	string	—
`namespace.adminPasswordSecretKmsKeyId`	string	—
`namespace.adminUsername`	string	—
`namespace.creationDate`	string	—
`namespace.dbName`	string	—
`namespace.defaultIamRoleArn`	string	—
`namespace.iamRoles`	array<string>	—
`namespace.kmsKeyId`	string	—
`namespace.logExports`	array<string>	—
`namespace.namespaceArn`	string	—
`namespace.namespaceId`	string	—
`namespace.namespaceName`	string	—
`namespace.status`	enum	—	Allowed: `AVAILABLE, MODIFYING, DELETING`
`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.

RedshiftServerlessSnapshot # CLOUD CONTROL · AWS::RedshiftServerless::Snapshot

RedshiftServerlessSnapshot manages AWS::RedshiftServerless::Snapshot through the AWS Cloud Control API.

kubectl get redshiftserverlesssnapshots · example on GitHub

Example

# RedshiftServerlessSnapshot — Redshift Serverless
# 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/redshiftserverless.html#redshiftserverlesssnapshot
apiVersion: aws.konfig.io/v1alpha1
kind: RedshiftServerlessSnapshot
metadata:
  name: example-redshiftserverlesssnapshot
  namespace: default
spec:
  namespaceName: example-redshiftserverlesssnapshot
  providerRef:
    name: example-redshiftserverlesssnapshot
    region: us-east-1
  retentionPeriod: 7
  snapshotName: example-redshiftserverlesssnapshot
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`namespaceName`	string	—	The namespace the snapshot is associated with.
`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.
`retentionPeriod`	integer	—	The retention period of the snapshot.
`snapshotName`	string	yes	The name of the snapshot.
`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.
`ownerAccount`	string	—	The owner account of the snapshot.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`snapshot`	object	—	Definition for snapshot resource Read-only: reported by AWS after creation.
`snapshot.adminUsername`	string	—
`snapshot.kmsKeyId`	string	—
`snapshot.namespaceArn`	string	—
`snapshot.namespaceName`	string	—
`snapshot.ownerAccount`	string	—
`snapshot.retentionPeriod`	integer	—
`snapshot.snapshotArn`	string	—
`snapshot.snapshotCreateTime`	string	—
`snapshot.snapshotName`	string	—
`snapshot.status`	enum	—	Allowed: `AVAILABLE, CREATING, DELETED, CANCELLED, FAILED, COPYING`

RedshiftServerlessWorkgroup # CLOUD CONTROL · AWS::RedshiftServerless::Workgroup

RedshiftServerlessWorkgroup manages AWS::RedshiftServerless::Workgroup through the AWS Cloud Control API.

kubectl get redshiftserverlessworkgroups · example on GitHub

Example

# RedshiftServerlessWorkgroup — Redshift Serverless
# 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/redshiftserverless.html#redshiftserverlessworkgroup
apiVersion: aws.konfig.io/v1alpha1
kind: RedshiftServerlessWorkgroup
metadata:
  name: example-redshiftserverlessworkgroup
  namespace: default
spec:
  baseCapacity: 2
  configParameters:
  - parameterKey: example
    parameterValue: example
  enhancedVpcRouting: false
  maxCapacity: 2
  namespaceName: example-redshiftserverlessworkgroup
  port: 443
  pricePerformanceTarget:
    level: 1
    status: ENABLED
  providerRef:
    name: example-redshiftserverlessworkgroup
    region: us-east-1
  publiclyAccessible: false
  securityGroupIds:
  - example
  snapshotArn: arn:aws:iam::123456789012:role/example-role
  snapshotName: example-redshiftserverlessworkgroup
  snapshotOwnerAccount: example
  subnetIds:
  - example
  tags:
  - key: example
    value: example
  trackName: example-redshiftserverlessworkgroup
  workgroup:
    baseCapacity: 2
    configParameters:
    - parameterKey: example
      parameterValue: example
    creationDate: example
    endpoint:
      address: example
      port: 443
      vpcEndpoints:
      - networkInterfaces:
        - availabilityZone: us-east-1a
          privateIpAddress: example
    enhancedVpcRouting: false
    maxCapacity: 2
    namespaceName: example-redshiftserverlessworkgroup
    pricePerformanceTarget:
      level: 1
      status: ENABLED
    publiclyAccessible: false
    securityGroupIds:
    - example
    status: CREATING
    subnetIds:
    - example
    trackName: example-redshiftserverlessworkgroup
    workgroupArn: arn:aws:iam::123456789012:role/example-role
    workgroupName: example-redshiftserverlessworkgroup
  workgroupName: example-redshiftserverlessworkgroup

Spec

Field	Type	Required	Description
`baseCapacity`	integer	—	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
`configParameters`	array<object>	—	A list of parameters to set for finer control over a database.
`configParameters[].parameterKey`	string	—
`configParameters[].parameterValue`	string	—
`enhancedVpcRouting`	boolean	—	The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
`maxCapacity`	integer	—	The max compute capacity of the workgroup in Redshift Processing Units (RPUs).
`namespaceName`	string	—	The namespace the workgroup is associated with.
`port`	integer	—	The custom port to use when connecting to a workgroup.
`pricePerformanceTarget`	object	—	A property that represents the price performance target settings for the workgroup.
`pricePerformanceTarget.level`	integer	—
`pricePerformanceTarget.status`	enum	—	Allowed: `ENABLED, DISABLED`
`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	—	A value that specifies whether the workgroup can be accessible from a public network.
`recoveryPointId`	string	—	The identifier of the recovery point to restore the namespace from.
`securityGroupIds`	array<string>	—	A list of security group IDs to associate with the workgroup.
`snapshotArn`	string	—	The Amazon Resource Name (ARN) of the snapshot to restore the namespace from.
`snapshotName`	string	—	The name of the snapshot to restore the namespace from.
`snapshotOwnerAccount`	string	—	The AWS account ID that owns the snapshot.
`subnetIds`	array<string>	—	A list of subnet IDs the workgroup is associated with.
`tags`	array<object>	—	The map of the key-value pairs used to tag the workgroup.
`tags[].key`	string	yes
`tags[].value`	string	yes
`trackName`	string	—
`workgroup`	object	—	Definition for workgroup resource
`workgroup.baseCapacity`	integer	—
`workgroup.configParameters`	array<object>	—
`workgroup.configParameters[].parameterKey`	string	—
`workgroup.configParameters[].parameterValue`	string	—
`workgroup.creationDate`	string	—
`workgroup.endpoint`	object	—	RedshiftServerlessWorkgroupEndpoint is a nested property type of AWS::RedshiftServerless::Workgroup.
`workgroup.endpoint.address`	string	—
`workgroup.endpoint.port`	integer	—
`workgroup.endpoint.vpcEndpoints`	array<object>	—
`workgroup.endpoint.vpcEndpoints[].networkInterfaces`	array<object>	—
`workgroup.endpoint.vpcEndpoints[].networkInterfaces[].availabilityZone`	string	—
`workgroup.endpoint.vpcEndpoints[].networkInterfaces[].networkInterfaceId`	string	—
`workgroup.endpoint.vpcEndpoints[].networkInterfaces[].privateIpAddress`	string	—
`workgroup.endpoint.vpcEndpoints[].networkInterfaces[].subnetId`	string	—
`workgroup.endpoint.vpcEndpoints[].vpcEndpointId`	string	—
`workgroup.endpoint.vpcEndpoints[].vpcId`	string	—
`workgroup.enhancedVpcRouting`	boolean	—
`workgroup.maxCapacity`	integer	—
`workgroup.namespaceName`	string	—
`workgroup.pricePerformanceTarget`	object	—	RedshiftServerlessWorkgroupPerformanceTarget is a nested property type of AWS::RedshiftServerless::Workgroup.
`workgroup.pricePerformanceTarget.level`	integer	—
`workgroup.pricePerformanceTarget.status`	enum	—	Allowed: `ENABLED, DISABLED`
`workgroup.publiclyAccessible`	boolean	—
`workgroup.securityGroupIds`	array<string>	—
`workgroup.status`	enum	—	Allowed: `CREATING, AVAILABLE, MODIFYING, DELETING`
`workgroup.subnetIds`	array<string>	—
`workgroup.trackName`	string	—
`workgroup.workgroupArn`	string	—
`workgroup.workgroupId`	string	—
`workgroup.workgroupName`	string	—
`workgroupName`	string	yes	The name of the workgroup.

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.