WorkGroup
athena.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | athena-controller/apis/v1alpha1#WorkGroup |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | WorkGroup |
| ListKind | WorkGroupList |
| Plural | workgroups |
| Singular | workgroup |
A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
Spec
configuration:
additionalConfiguration: string
bytesScannedCutoffPerQuery: integer
customerContentEncryptionConfiguration:
kmsKey: string
enableMinimumEncryptionConfiguration: boolean
enforceWorkGroupConfiguration: boolean
engineVersion:
effectiveEngineVersion: string
selectedEngineVersion: string
executionRole: string
identityCenterConfiguration:
enableIdentityCenter: boolean
identityCenterInstanceARN: string
publishCloudWatchMetricsEnabled: boolean
queryResultsS3AccessGrantsConfiguration:
authenticationType: string
createUserLevelPrefix: boolean
enableS3AccessGrants: boolean
requesterPaysEnabled: boolean
resultConfiguration:
aclConfiguration:
s3ACLOption: string
encryptionConfiguration:
encryptionOption: string
kmsKey: string
expectedBucketOwner: string
outputLocation: string
description: string
name: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| configuration Optional | object Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup’s settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. |
| configuration.additionalConfiguration Optional | string |
| configuration.bytesScannedCutoffPerQuery Optional | integer |
| configuration.customerContentEncryptionConfiguration Optional | object Specifies the customer managed KMS key that is used to encrypt the user’s data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups. |
| configuration.customerContentEncryptionConfiguration.kmsKey Optional | string |
| configuration.enableMinimumEncryptionConfiguration Optional | boolean |
| configuration.enforceWorkGroupConfiguration Optional | boolean |
| configuration.engineVersion Optional | object The Athena engine version for running queries, or the PySpark engine version for running sessions. |
| configuration.engineVersion.effectiveEngineVersion Optional | string |
| configuration.engineVersion.selectedEngineVersion Optional | string |
| configuration.executionRole Optional | string |
| configuration.identityCenterConfiguration Optional | object Specifies whether the workgroup is IAM Identity Center supported. |
| configuration.identityCenterConfiguration.enableIdentityCenter Optional | boolean |
| configuration.identityCenterConfiguration.identityCenterInstanceARN Optional | string |
| configuration.publishCloudWatchMetricsEnabled Optional | boolean |
| configuration.queryResultsS3AccessGrantsConfiguration Optional | object Specifies whether Amazon S3 access grants are enabled for query results. |
| configuration.queryResultsS3AccessGrantsConfiguration.authenticationType Optional | string |
| configuration.queryResultsS3AccessGrantsConfiguration.createUserLevelPrefix Optional | boolean |
| configuration.queryResultsS3AccessGrantsConfiguration.enableS3AccessGrants Optional | boolean |
| configuration.requesterPaysEnabled Optional | boolean |
| configuration.resultConfiguration Optional | object The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as “client-side settings”. If workgroup settings override client-side settings, then the query uses the workgroup settings. |
| configuration.resultConfiguration.aclConfiguration Optional | object Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview) in the Amazon S3 User Guide. |
| configuration.resultConfiguration.aclConfiguration.s3ACLOption Optional | string |
| configuration.resultConfiguration.encryptionConfiguration Optional | object If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information. |
| configuration.resultConfiguration.encryptionConfiguration.encryptionOption Optional | string |
| configuration.resultConfiguration.encryptionConfiguration.kmsKey Optional | string |
| configuration.resultConfiguration.expectedBucketOwner Optional | string |
| configuration.resultConfiguration.outputLocation Optional | string |
| description Optional | string The workgroup description. |
| name Required | string The workgroup name. |
| tags Optional | array A list of comma separated tags to add to the workgroup that is created. |
| tags.[] Required | object A label that you assign to a resource. Athena resources include workgroups, |
| data catalogs, and capacity reservations. Each tag consists of a key and | |
| an optional value, both of which you define. For example, you can use tags | |
| to categorize Athena resources by purpose, owner, or environment. Use a consistent | |
| set of tag keys to make it easier to search and filter the resources in your | |
| account. For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). | |
| Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can | |
| be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers | |
| representable in UTF-8, and the following characters: + - = . _ : / @. Tag | |
| keys and values are case-sensitive. Tag keys must be unique per resource. | |
| If you specify more than one tag, separate them by commas. | |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |