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

FieldTypeRequiredDescription
capacityAssignmentConfigurationobject—AthenaCapacityReservationCapacityAssignmentConfiguration is a nested property type of AWS::Athena::CapacityReservation.
capacityAssignmentConfiguration.capacityAssignmentsarray<object>yes
capacityAssignmentConfiguration.capacityAssignments[].workgroupNamesarray<string>yes
namestringyesThe reservation name.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—An array of key-value pairs to apply to this resource.
tags[].keystringyes
tags[].valuestringyes
targetDpusintegeryesThe number of DPUs to request to be allocated to the reservation.

Status

FieldTypeRequiredDescription
allocatedDpusinteger—The number of DPUs Athena has provisioned and allocated for the reservation Read-only: reported by AWS after creation.
arnstring—Read-only: reported by AWS after creation.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
creationTimestring—The date and time the reservation was created.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSuccessfulAllocationTimestring—The timestamp when the last successful allocated was made Read-only: reported by AWS after creation.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
statusenum—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

FieldTypeRequiredDescription
descriptionstring—Description is a description of the data catalog.
namestringyesName is the data catalog name.
parametersmap<string>—Parameters are type-specific key-value pairs (e.g.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsmap<string>—Tags are AWS resource tags to apply at creation.
typeenumyesType is the catalog type: LAMBDA, GLUE, or HIVE. Allowed: LAMBDA, GLUE, HIVE

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
catalogNamestring—CatalogName is the name of the data catalog in AWS.
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—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

FieldTypeRequiredDescription
databasestringyesDatabase is the database to which the query belongs.
descriptionstring—Description is a description of the query.
namestringyesName is the query name.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
queryStringstringyesQueryString is the SQL statements that make up the query.
workGroupstring—WorkGroup is the workgroup in which the named query is saved.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
namedQueryIdstring—NamedQueryID is the unique ID of the query in AWS.
observedGenerationinteger—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

FieldTypeRequiredDescription
descriptionstring—The description of the prepared statement.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
queryStatementstringyesThe query string for the prepared statement.
statementNamestringyesThe name of the prepared statement.
workGroupstringyesThe name of the workgroup to which the prepared statement belongs.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
bytesScannedCutoffPerQueryinteger—BytesScannedCutoffPerQuery is the per-query data scan limit in bytes.
descriptionstring—Description is a description of the workgroup.
enforceWorkGroupConfigurationboolean—EnforceWorkGroupConfiguration makes workgroup settings override client-side settings.
namestringyesName is the workgroup name.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
publishCloudWatchMetricsEnabledboolean—PublishCloudWatchMetricsEnabled publishes query metrics to CloudWatch.
resultConfigurationobject—ResultConfiguration configures where and how query results are stored.
resultConfiguration.encryptionConfigurationobject—EncryptionConfiguration configures result encryption.
resultConfiguration.encryptionConfiguration.encryptionOptionenumyesEncryptionOption is SSE_S3, SSE_KMS, or CSE_KMS. Allowed: SSE_S3, SSE_KMS, CSE_KMS
resultConfiguration.encryptionConfiguration.kmsKeystring—KMSKey is the KMS key ARN or ID for SSE_KMS and CSE_KMS.
resultConfiguration.outputLocationstring—OutputLocation is the S3 location where query results are stored, e.g.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
statestring—State is the workgroup state (ENABLED/DISABLED).
workGroupNamestring—WorkGroupName is the name of the workgroup in AWS.