WorkgroupWorkgroup is the Schema for the Workgroups API. Manages an Athena Workgroup.
TypeMR
Providerprovider-aws-athena
Groupathena.aws.m.upbound.io
Scopenamespaced
Versionv1beta1

1apiVersion: athena.aws.m.upbound.io/v1beta1

2kind: Workgroup

kind
string
metadata
object
spec
object

WorkgroupSpec defines the desired state of Workgroup

forProvider
required
object

(No description available)

object

Configuration block with various settings for the workgroup. Documented below.

object

Configuration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.

kmsKey
string
object

Configuration block for the Athena Engine Versioning. For more information, see Athena Engine Versioning. See Engine Version below.

object

Configuration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.

object

Configuration block for storing results in Athena owned storage. See Managed Query Results Configuration below.

enabled
boolean
object

Configuration block with encryption settings. See Encryption Configuration below.

kmsKey
string
object

Configuration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.

object

Configuration block for delivering logs to Amazon CloudWatch log groups. See CloudWatch Logging Configuration below.

enabled
boolean
logGroup
string
logType
array

Repeatable block defining log types to be delivered to CloudWatch.

key
string
values
array

List of log types to be delivered to CloudWatch (for example, STDOUT and STDERR).

object

Configuration block for managed log persistence. See Managed Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for delivering logs to Amazon S3 buckets. See S3 Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for S3 access grants. See Query Results S3 Access Grants Configuration below.

object

Configuration block with result settings. See Result Configuration below.

object

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

object

Configuration block with encryption settings. See Encryption Configuration below.

kmsKeyArn
string
object

Reference to a Key in kms to populate kmsKeyArn.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate kmsKeyArn.

namespace
string
policy
object

Policies for selection.

resolve
string
region
required
string
state
string
tags
object
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

object

Configuration block with various settings for the workgroup. Documented below.

object

Configuration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.

kmsKey
string
object

Configuration block for the Athena Engine Versioning. For more information, see Athena Engine Versioning. See Engine Version below.

object

Configuration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.

object

Configuration block for storing results in Athena owned storage. See Managed Query Results Configuration below.

enabled
boolean
object

Configuration block with encryption settings. See Encryption Configuration below.

kmsKey
string
object

Configuration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.

object

Configuration block for delivering logs to Amazon CloudWatch log groups. See CloudWatch Logging Configuration below.

enabled
boolean
logGroup
string
logType
array

Repeatable block defining log types to be delivered to CloudWatch.

key
string
values
array

List of log types to be delivered to CloudWatch (for example, STDOUT and STDERR).

object

Configuration block for managed log persistence. See Managed Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for delivering logs to Amazon S3 buckets. See S3 Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for S3 access grants. See Query Results S3 Access Grants Configuration below.

object

Configuration block with result settings. See Result Configuration below.

object

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

object

Configuration block with encryption settings. See Encryption Configuration below.

kmsKeyArn
string
object

Reference to a Key in kms to populate kmsKeyArn.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate kmsKeyArn.

namespace
string
policy
object

Policies for selection.

resolve
string
state
string
tags
object
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

WorkgroupStatus defines the observed state of Workgroup.

object

(No description available)

arn
string
object

Configuration block with various settings for the workgroup. Documented below.

object

Configuration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.

kmsKey
string
object

Configuration block for the Athena Engine Versioning. For more information, see Athena Engine Versioning. See Engine Version below.

object

Configuration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.

object

Configuration block for storing results in Athena owned storage. See Managed Query Results Configuration below.

enabled
boolean
object

Configuration block with encryption settings. See Encryption Configuration below.

kmsKey
string
object

Configuration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.

object

Configuration block for delivering logs to Amazon CloudWatch log groups. See CloudWatch Logging Configuration below.

enabled
boolean
logGroup
string
logType
array

Repeatable block defining log types to be delivered to CloudWatch.

key
string
values
array

List of log types to be delivered to CloudWatch (for example, STDOUT and STDERR).

object

Configuration block for managed log persistence. See Managed Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for delivering logs to Amazon S3 buckets. See S3 Logging Configuration below.

enabled
boolean
kmsKey
string
object

Configuration block for S3 access grants. See Query Results S3 Access Grants Configuration below.

object

Configuration block with result settings. See Result Configuration below.

object

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

object

Configuration block with encryption settings. See Encryption Configuration below.

id
string
region
string
state
string
tags
object
tagsAll
object
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string