Athena
5 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
AthenaCapacityReservation # CLOUD CONTROL · AWS::Athena::CapacityReservation
AthenaCapacityReservation manages AWS::Athena::CapacityReservation through the AWS Cloud Control API.
kubectl get athenacapacityreservations · example on GitHub
Example
# AthenaCapacityReservation — Athena
# 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/athena.html#athenacapacityreservation
apiVersion: aws.konfig.io/v1alpha1
kind: AthenaCapacityReservation
metadata:
name: example-athenacapacityreservation
namespace: default
spec:
capacityAssignmentConfiguration:
capacityAssignments:
- workgroupNames:
- example
name: example-athenacapacityreservation
providerRef:
name: example-athenacapacityreservation
region: us-east-1
tags:
- key: example
value: example
targetDpus: 1
Spec
| Field | Type | Required | Description |
|---|---|---|---|
capacityAssignmentConfiguration | object | — | AthenaCapacityReservationCapacityAssignmentConfiguration is a nested property type of AWS::Athena::CapacityReservation. |
capacityAssignmentConfiguration.capacityAssignments | array<object> | yes | |
capacityAssignmentConfiguration.capacityAssignments[].workgroupNames | array<string> | yes | |
name | string | yes | The reservation name. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
tags | array<object> | — | An array of key-value pairs to apply to this resource. |
tags[].key | string | yes | |
tags[].value | string | yes | |
targetDpus | integer | yes | The number of DPUs to request to be allocated to the reservation. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
allocatedDpus | integer | — | The number of DPUs Athena has provisioned and allocated for the reservation Read-only: reported by AWS after creation. |
arn | string | — | Read-only: reported by AWS after creation. |
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. |
creationTime | string | — | The date and time the reservation was created. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSuccessfulAllocationTime | string | — | The timestamp when the last successful allocated was made 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. |
status | enum | — | The status of the reservation. Allowed: PENDING, ACTIVE, CANCELLING, CANCELLED, FAILED, UPDATE_PENDING |
AthenaDataCatalog # GA
AthenaDataCatalog is the Schema for managing Athena data catalogs.
kubectl get athenadatacatalogs · example on GitHub
Example
# AthenaDataCatalog — Athena
# 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/athena.html#athenadatacatalog
apiVersion: aws.konfig.io/v1alpha1
kind: AthenaDataCatalog
metadata:
name: example-athenadatacatalog
namespace: default
spec:
description: Managed by konfig-konector
name: example-athenadatacatalog
parameters:
key: value
providerRef:
name: example-athenadatacatalog
region: us-east-1
tags:
environment: dev
team: platform
type: LAMBDA
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description is a description of the data catalog. |
name | string | yes | Name is the data catalog name. |
parameters | map<string> | — | Parameters are type-specific key-value pairs (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. |
tags | map<string> | — | Tags are AWS resource tags to apply at creation. |
type | enum | yes | Type is the catalog type: LAMBDA, GLUE, or HIVE. Allowed: LAMBDA, GLUE, HIVE |
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). |
catalogName | string | — | CatalogName is the name of the data catalog in AWS. |
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. |
AthenaNamedQuery # GA
AthenaNamedQuery is the Schema for managing Athena named queries.
kubectl get athenanamedqueries · example on GitHub
Example
# AthenaNamedQuery — Athena
# 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/athena.html#athenanamedquery
apiVersion: aws.konfig.io/v1alpha1
kind: AthenaNamedQuery
metadata:
name: example-athenanamedquery
namespace: default
spec:
database: example
description: Managed by konfig-konector
name: example-athenanamedquery
providerRef:
name: example-athenanamedquery
region: us-east-1
queryString: example
workGroup: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
database | string | yes | Database is the database to which the query belongs. |
description | string | — | Description is a description of the query. |
name | string | yes | Name is the query name. |
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. |
queryString | string | yes | QueryString is the SQL statements that make up the query. |
workGroup | string | — | WorkGroup is the workgroup in which the named query is saved. |
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. |
namedQueryId | string | — | NamedQueryID is the unique ID of the query in AWS. |
observedGeneration | integer | — | ObservedGeneration is the most recent .metadata.generation reconciled. |
AthenaPreparedStatement # CLOUD CONTROL · AWS::Athena::PreparedStatement
AthenaPreparedStatement manages AWS::Athena::PreparedStatement through the AWS Cloud Control API.
kubectl get athenapreparedstatements · example on GitHub
Example
# AthenaPreparedStatement — Athena
# 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/athena.html#athenapreparedstatement
apiVersion: aws.konfig.io/v1alpha1
kind: AthenaPreparedStatement
metadata:
name: example-athenapreparedstatement
namespace: default
spec:
description: Managed by konfig-konector
providerRef:
name: example-athenapreparedstatement
region: us-east-1
queryStatement: example
statementName: example-athenapreparedstatement
workGroup: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | The description of the prepared statement. |
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. |
queryStatement | string | yes | The query string for the prepared statement. |
statementName | string | yes | The name of the prepared statement. |
workGroup | string | yes | The name of the workgroup to which the prepared statement belongs. |
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. |
AthenaWorkGroup # GA
AthenaWorkGroup is the Schema for managing Athena workgroups.
kubectl get athenaworkgroups · example on GitHub
Example
# AthenaWorkGroup — Athena
# 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/athena.html#athenaworkgroup
apiVersion: aws.konfig.io/v1alpha1
kind: AthenaWorkGroup
metadata:
name: example-athenaworkgroup
namespace: default
spec:
bytesScannedCutoffPerQuery: 10000000
description: Managed by konfig-konector
enforceWorkGroupConfiguration: false
name: example-athenaworkgroup
providerRef:
name: example-athenaworkgroup
region: us-east-1
publishCloudWatchMetricsEnabled: true
resultConfiguration:
encryptionConfiguration:
encryptionOption: SSE_S3
kmsKey: example
outputLocation: example
tags:
environment: dev
team: platform
Spec
| Field | Type | Required | Description |
|---|---|---|---|
bytesScannedCutoffPerQuery | integer | — | BytesScannedCutoffPerQuery is the per-query data scan limit in bytes. |
description | string | — | Description is a description of the workgroup. |
enforceWorkGroupConfiguration | boolean | — | EnforceWorkGroupConfiguration makes workgroup settings override client-side settings. |
name | string | yes | Name is the workgroup name. |
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. |
publishCloudWatchMetricsEnabled | boolean | — | PublishCloudWatchMetricsEnabled publishes query metrics to CloudWatch. |
resultConfiguration | object | — | ResultConfiguration configures where and how query results are stored. |
resultConfiguration.encryptionConfiguration | object | — | EncryptionConfiguration configures result encryption. |
resultConfiguration.encryptionConfiguration.encryptionOption | enum | yes | EncryptionOption is SSE_S3, SSE_KMS, or CSE_KMS. Allowed: SSE_S3, SSE_KMS, CSE_KMS |
resultConfiguration.encryptionConfiguration.kmsKey | string | — | KMSKey is the KMS key ARN or ID for SSE_KMS and CSE_KMS. |
resultConfiguration.outputLocation | string | — | OutputLocation is the S3 location where query results are stored, e.g. |
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. |
state | string | — | State is the workgroup state (ENABLED/DISABLED). |
workGroupName | string | — | WorkGroupName is the name of the workgroup in AWS. |