We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::Athena::WorkGroup
Using getWorkGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getWorkGroup(args: GetWorkGroupArgs, opts?: InvokeOptions): Promise<GetWorkGroupResult>
function getWorkGroupOutput(args: GetWorkGroupOutputArgs, opts?: InvokeOptions): Output<GetWorkGroupResult>def get_work_group(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkGroupResult
def get_work_group_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWorkGroupResult]func LookupWorkGroup(ctx *Context, args *LookupWorkGroupArgs, opts ...InvokeOption) (*LookupWorkGroupResult, error)
func LookupWorkGroupOutput(ctx *Context, args *LookupWorkGroupOutputArgs, opts ...InvokeOption) LookupWorkGroupResultOutput> Note: This function is named LookupWorkGroup in the Go SDK.
public static class GetWorkGroup
{
public static Task<GetWorkGroupResult> InvokeAsync(GetWorkGroupArgs args, InvokeOptions? opts = null)
public static Output<GetWorkGroupResult> Invoke(GetWorkGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetWorkGroupResult> getWorkGroup(GetWorkGroupArgs args, InvokeOptions options)
public static Output<GetWorkGroupResult> getWorkGroup(GetWorkGroupArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:athena:getWorkGroup
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The workGroup name.
- Name string
- The workGroup name.
- name String
- The workGroup name.
- name string
- The workGroup name.
- name str
- The workGroup name.
- name String
- The workGroup name.
getWorkGroup Result
The following output properties are available:
- Creation
Time string - The date and time the workgroup was created.
- Description string
- The workgroup description.
- State
Pulumi.
Aws Native. Athena. Work Group State - The state of the workgroup: ENABLED or DISABLED.
-
List<Pulumi.
Aws Native. Outputs. Tag> - One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- Work
Group Pulumi.Configuration Aws Native. Athena. Outputs. Work Group Configuration - The workgroup configuration
- Creation
Time string - The date and time the workgroup was created.
- Description string
- The workgroup description.
- State
Work
Group State Enum - The state of the workgroup: ENABLED or DISABLED.
- Tag
- One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- Work
Group WorkConfiguration Group Configuration - The workgroup configuration
- creation
Time String - The date and time the workgroup was created.
- description String
- The workgroup description.
- state
Work
Group State - The state of the workgroup: ENABLED or DISABLED.
- List<Tag>
- One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- work
Group WorkConfiguration Group Configuration - The workgroup configuration
- creation
Time string - The date and time the workgroup was created.
- description string
- The workgroup description.
- state
Work
Group State - The state of the workgroup: ENABLED or DISABLED.
- Tag[]
- One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- work
Group WorkConfiguration Group Configuration - The workgroup configuration
- creation_
time str - The date and time the workgroup was created.
- description str
- The workgroup description.
- state
Work
Group State - The state of the workgroup: ENABLED or DISABLED.
- Sequence[root_Tag]
- One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- work_
group_ Workconfiguration Group Configuration - The workgroup configuration
- creation
Time String - The date and time the workgroup was created.
- description String
- The workgroup description.
- state "ENABLED" | "DISABLED"
- The state of the workgroup: ENABLED or DISABLED.
- List<Property Map>
- One or more tags, separated by commas, that you want to attach to the workgroup as you create it
- work
Group Property MapConfiguration - The workgroup configuration
Supporting Types
Tag
WorkGroupAclConfiguration
- S3Acl
Option Pulumi.Aws Native. Athena. Work Group S3Acl Option - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
- S3Acl
Option WorkGroup S3Acl Option - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
- s3Acl
Option WorkGroup S3Acl Option - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
- s3Acl
Option WorkGroup S3Acl Option - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
- s3_
acl_ Workoption Group S3Acl Option - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
- s3Acl
Option "BUCKET_OWNER_FULL_CONTROL" - The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .
WorkGroupClassification
- Name string
- The name of the configuration classification.
- Properties Dictionary<string, string>
- A set of properties specified within a configuration classification.
- Name string
- The name of the configuration classification.
- Properties map[string]string
- A set of properties specified within a configuration classification.
- name String
- The name of the configuration classification.
- properties Map<String,String>
- A set of properties specified within a configuration classification.
- name string
- The name of the configuration classification.
- properties {[key: string]: string}
- A set of properties specified within a configuration classification.
- name str
- The name of the configuration classification.
- properties Mapping[str, str]
- A set of properties specified within a configuration classification.
- name String
- The name of the configuration classification.
- properties Map<String>
- A set of properties specified within a configuration classification.
WorkGroupCloudWatchLoggingConfiguration
- Enabled bool
- Enables CloudWatch logging.
- Log
Group string - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- Log
Stream stringName Prefix - Prefix for the CloudWatch log stream name.
- Log
Types Dictionary<string, ImmutableArray<string>> - The types of logs that you want to publish to CloudWatch.
- Enabled bool
- Enables CloudWatch logging.
- Log
Group string - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- Log
Stream stringName Prefix - Prefix for the CloudWatch log stream name.
- Log
Types map[string][]string - The types of logs that you want to publish to CloudWatch.
- enabled Boolean
- Enables CloudWatch logging.
- log
Group String - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- log
Stream StringName Prefix - Prefix for the CloudWatch log stream name.
- log
Types Map<String,List<String>> - The types of logs that you want to publish to CloudWatch.
- enabled boolean
- Enables CloudWatch logging.
- log
Group string - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- log
Stream stringName Prefix - Prefix for the CloudWatch log stream name.
- log
Types {[key: string]: string[]} - The types of logs that you want to publish to CloudWatch.
- enabled bool
- Enables CloudWatch logging.
- log_
group str - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- log_
stream_ strname_ prefix - Prefix for the CloudWatch log stream name.
- log_
types Mapping[str, Sequence[str]] - The types of logs that you want to publish to CloudWatch.
- enabled Boolean
- Enables CloudWatch logging.
- log
Group String - The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.
- log
Stream StringName Prefix - Prefix for the CloudWatch log stream name.
- log
Types Map<List<String>> - The types of logs that you want to publish to CloudWatch.
WorkGroupConfiguration
- Additional
Configuration string - Specifies a user defined JSON string that is passed to the session engine.
- Bytes
Scanned intCutoff Per Query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- Customer
Content Pulumi.Encryption Configuration Aws Native. Athena. Inputs. Work Group Customer Content Encryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- Enforce
Work boolGroup Configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- Engine
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Engine Configuration - Engine
Version Pulumi.Aws Native. Athena. Inputs. Work Group Engine Version - The engine version that all queries running on the workgroup use.
- Execution
Role string - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- Managed
Query Pulumi.Results Configuration Aws Native. Athena. Inputs. Work Group Managed Query Results Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- Monitoring
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Monitoring Configuration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- Publish
Cloud boolWatch Metrics Enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- Requester
Pays boolEnabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - Result
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Result Configuration - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
- Additional
Configuration string - Specifies a user defined JSON string that is passed to the session engine.
- Bytes
Scanned intCutoff Per Query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- Customer
Content WorkEncryption Configuration Group Customer Content Encryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- Enforce
Work boolGroup Configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- Engine
Configuration WorkGroup Engine Configuration - Engine
Version WorkGroup Engine Version - The engine version that all queries running on the workgroup use.
- Execution
Role string - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- Managed
Query WorkResults Configuration Group Managed Query Results Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- Monitoring
Configuration WorkGroup Monitoring Configuration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- Publish
Cloud boolWatch Metrics Enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- Requester
Pays boolEnabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - Result
Configuration WorkGroup Result Configuration - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
- additional
Configuration String - Specifies a user defined JSON string that is passed to the session engine.
- bytes
Scanned IntegerCutoff Per Query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- customer
Content WorkEncryption Configuration Group Customer Content Encryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- enforce
Work BooleanGroup Configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- engine
Configuration WorkGroup Engine Configuration - engine
Version WorkGroup Engine Version - The engine version that all queries running on the workgroup use.
- execution
Role String - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- managed
Query WorkResults Configuration Group Managed Query Results Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- monitoring
Configuration WorkGroup Monitoring Configuration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- publish
Cloud BooleanWatch Metrics Enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- requester
Pays BooleanEnabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - result
Configuration WorkGroup Result Configuration - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
- additional
Configuration string - Specifies a user defined JSON string that is passed to the session engine.
- bytes
Scanned numberCutoff Per Query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- customer
Content WorkEncryption Configuration Group Customer Content Encryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- enforce
Work booleanGroup Configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- engine
Configuration WorkGroup Engine Configuration - engine
Version WorkGroup Engine Version - The engine version that all queries running on the workgroup use.
- execution
Role string - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- managed
Query WorkResults Configuration Group Managed Query Results Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- monitoring
Configuration WorkGroup Monitoring Configuration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- publish
Cloud booleanWatch Metrics Enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- requester
Pays booleanEnabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - result
Configuration WorkGroup Result Configuration - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
- additional_
configuration str - Specifies a user defined JSON string that is passed to the session engine.
- bytes_
scanned_ intcutoff_ per_ query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- customer_
content_ Workencryption_ configuration Group Customer Content Encryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- enforce_
work_ boolgroup_ configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- engine_
configuration WorkGroup Engine Configuration - engine_
version WorkGroup Engine Version - The engine version that all queries running on the workgroup use.
- execution_
role str - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- managed_
query_ Workresults_ configuration Group Managed Query Results Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- monitoring_
configuration WorkGroup Monitoring Configuration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- publish_
cloud_ boolwatch_ metrics_ enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- requester_
pays_ boolenabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - result_
configuration WorkGroup Result Configuration - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
- additional
Configuration String - Specifies a user defined JSON string that is passed to the session engine.
- bytes
Scanned NumberCutoff Per Query The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
- customer
Content Property MapEncryption Configuration - Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
- enforce
Work BooleanGroup Configuration - If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
- engine
Configuration Property Map - engine
Version Property Map - The engine version that all queries running on the workgroup use.
- execution
Role String - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
- managed
Query Property MapResults Configuration - The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
- monitoring
Configuration Property Map - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
- publish
Cloud BooleanWatch Metrics Enabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- requester
Pays BooleanEnabled - If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . - result
Configuration Property Map - Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .
WorkGroupCustomerContentEncryptionConfiguration
- Kms
Key string - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
- Kms
Key string - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
- kms
Key String - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
- kms
Key string - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
- kms_
key str - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
- kms
Key String - The customer managed KMS key that is used to encrypt the user's data stores in Athena.
WorkGroupEncryptionConfiguration
- Encryption
Option Pulumi.Aws Native. Athena. Work Group Encryption Option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- Kms
Key string - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
- Encryption
Option WorkGroup Encryption Option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- Kms
Key string - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
- encryption
Option WorkGroup Encryption Option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- kms
Key String - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
- encryption
Option WorkGroup Encryption Option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- kms
Key string - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
- encryption_
option WorkGroup Encryption Option Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- kms_
key str - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
- encryption
Option "SSE_S3" | "SSE_KMS" | "CSE_KMS" Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (CSE_KMS) is used.If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
- kms
Key String - For
SSE_KMSandCSE_KMS, this is the KMS key ARN or ID.
WorkGroupEncryptionOption
WorkGroupEngineConfiguration
- Additional
Configs Dictionary<string, string> - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- Classifications
List<Pulumi.
Aws Native. Athena. Inputs. Work Group Classification> - The configuration classifications that can be specified for the engine.
- Coordinator
Dpu intSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- Default
Executor intDpu Size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- Max
Concurrent intDpus - The maximum number of DPUs that can run concurrently.
- Spark
Properties Dictionary<string, string> - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
- Additional
Configs map[string]string - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- Classifications
[]Work
Group Classification - The configuration classifications that can be specified for the engine.
- Coordinator
Dpu intSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- Default
Executor intDpu Size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- Max
Concurrent intDpus - The maximum number of DPUs that can run concurrently.
- Spark
Properties map[string]string - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
- additional
Configs Map<String,String> - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- classifications
List<Work
Group Classification> - The configuration classifications that can be specified for the engine.
- coordinator
Dpu IntegerSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- default
Executor IntegerDpu Size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- max
Concurrent IntegerDpus - The maximum number of DPUs that can run concurrently.
- spark
Properties Map<String,String> - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
- additional
Configs {[key: string]: string} - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- classifications
Work
Group Classification[] - The configuration classifications that can be specified for the engine.
- coordinator
Dpu numberSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- default
Executor numberDpu Size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- max
Concurrent numberDpus - The maximum number of DPUs that can run concurrently.
- spark
Properties {[key: string]: string} - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
- additional_
configs Mapping[str, str] - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- classifications
Sequence[Work
Group Classification] - The configuration classifications that can be specified for the engine.
- coordinator_
dpu_ intsize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- default_
executor_ intdpu_ size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- max_
concurrent_ intdpus - The maximum number of DPUs that can run concurrently.
- spark_
properties Mapping[str, str] - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
- additional
Configs Map<String> - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
- classifications List<Property Map>
- The configuration classifications that can be specified for the engine.
- coordinator
Dpu NumberSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.
- default
Executor NumberDpu Size - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.
- max
Concurrent NumberDpus - The maximum number of DPUs that can run concurrently.
- spark
Properties Map<String> - Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
WorkGroupEngineVersion
- Effective
Engine stringVersion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - Selected
Engine stringVersion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
- Effective
Engine stringVersion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - Selected
Engine stringVersion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
- effective
Engine StringVersion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - selected
Engine StringVersion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
- effective
Engine stringVersion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - selected
Engine stringVersion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
- effective_
engine_ strversion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - selected_
engine_ strversion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
- effective
Engine StringVersion - Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a
CreateWorkGrouporUpdateWorkGroupoperation, theEffectiveEngineVersionfield is ignored. - selected
Engine StringVersion - The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including AUTO. The default is AUTO.
WorkGroupManagedLoggingConfiguration
WorkGroupManagedQueryResultsConfiguration
- Enabled bool
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - Encryption
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Managed Storage Encryption Configuration - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
- Enabled bool
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - Encryption
Configuration WorkGroup Managed Storage Encryption Configuration - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
- enabled Boolean
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - encryption
Configuration WorkGroup Managed Storage Encryption Configuration - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
- enabled boolean
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - encryption
Configuration WorkGroup Managed Storage Encryption Configuration - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
- enabled bool
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - encryption_
configuration WorkGroup Managed Storage Encryption Configuration - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
- enabled Boolean
- If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under
ResultConfiguration$OutputLocation. The default is false. A workgroup cannot have theResultConfiguration$OutputLocationparameter when you set this field to true. - encryption
Configuration Property Map - If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.
WorkGroupManagedStorageEncryptionConfiguration
- Kms
Key string
- Kms
Key string
- kms
Key String
- kms
Key string
- kms_
key str
- kms
Key String
WorkGroupMonitoringConfiguration
- Cloud
Watch Pulumi.Logging Configuration Aws Native. Athena. Inputs. Work Group Cloud Watch Logging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- Managed
Logging Pulumi.Configuration Aws Native. Athena. Inputs. Work Group Managed Logging Configuration - Configuration settings for managed log persistence.
- S3Logging
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group S3Logging Configuration - Configuration settings for delivering logs to Amazon S3 buckets.
- Cloud
Watch WorkLogging Configuration Group Cloud Watch Logging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- Managed
Logging WorkConfiguration Group Managed Logging Configuration - Configuration settings for managed log persistence.
- S3Logging
Configuration WorkGroup S3Logging Configuration - Configuration settings for delivering logs to Amazon S3 buckets.
- cloud
Watch WorkLogging Configuration Group Cloud Watch Logging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- managed
Logging WorkConfiguration Group Managed Logging Configuration - Configuration settings for managed log persistence.
- s3Logging
Configuration WorkGroup S3Logging Configuration - Configuration settings for delivering logs to Amazon S3 buckets.
- cloud
Watch WorkLogging Configuration Group Cloud Watch Logging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- managed
Logging WorkConfiguration Group Managed Logging Configuration - Configuration settings for managed log persistence.
- s3Logging
Configuration WorkGroup S3Logging Configuration - Configuration settings for delivering logs to Amazon S3 buckets.
- cloud_
watch_ Worklogging_ configuration Group Cloud Watch Logging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- managed_
logging_ Workconfiguration Group Managed Logging Configuration - Configuration settings for managed log persistence.
- s3_
logging_ Workconfiguration Group S3Logging Configuration - Configuration settings for delivering logs to Amazon S3 buckets.
- cloud
Watch Property MapLogging Configuration - Configuration settings for delivering logs to Amazon CloudWatch log groups.
- managed
Logging Property MapConfiguration - Configuration settings for managed log persistence.
- s3Logging
Configuration Property Map - Configuration settings for delivering logs to Amazon S3 buckets.
WorkGroupResultConfiguration
- Acl
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Acl Configuration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - Encryption
Configuration Pulumi.Aws Native. Athena. Inputs. Work Group Encryption Configuration - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - Expected
Bucket stringOwner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- Output
Location string - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
- Acl
Configuration WorkGroup Acl Configuration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - Encryption
Configuration WorkGroup Encryption Configuration - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - Expected
Bucket stringOwner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- Output
Location string - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
- acl
Configuration WorkGroup Acl Configuration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - encryption
Configuration WorkGroup Encryption Configuration - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - expected
Bucket StringOwner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- output
Location String - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
- acl
Configuration WorkGroup Acl Configuration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - encryption
Configuration WorkGroup Encryption Configuration - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - expected
Bucket stringOwner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- output
Location string - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
- acl_
configuration WorkGroup Acl Configuration - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - encryption_
configuration WorkGroup Encryption Configuration - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - expected_
bucket_ strowner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- output_
location str - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
- acl
Configuration Property Map - Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration. - encryption
Configuration Property Map - If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfigurationand Override client-side settings . - expected
Bucket StringOwner The account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration:OutputLocation. If set, Athena uses the value forExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwneraccount ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. SeeEnforceWorkGroupConfiguration.- output
Location String - The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries andEnforceWorkGroupConfiguration.
WorkGroupS3AclOption
WorkGroupS3LoggingConfiguration
- Enabled bool
- Enables S3 log delivery.
- Kms
Key string - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- Log
Location string - The Amazon S3 destination URI for log publishing.
- Enabled bool
- Enables S3 log delivery.
- Kms
Key string - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- Log
Location string - The Amazon S3 destination URI for log publishing.
- enabled Boolean
- Enables S3 log delivery.
- kms
Key String - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- log
Location String - The Amazon S3 destination URI for log publishing.
- enabled boolean
- Enables S3 log delivery.
- kms
Key string - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- log
Location string - The Amazon S3 destination URI for log publishing.
- enabled bool
- Enables S3 log delivery.
- kms_
key str - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- log_
location str - The Amazon S3 destination URI for log publishing.
- enabled Boolean
- Enables S3 log delivery.
- kms
Key String - The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
- log
Location String - The Amazon S3 destination URI for log publishing.
WorkGroupState
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
