Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. athena
  5. getWorkGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.athena.getWorkGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:athena:getWorkGroup
  arguments:
    # arguments dictionary

    The 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:

    CreationTime string
    The date and time the workgroup was created.
    Description string
    The workgroup description.
    State Pulumi.AwsNative.Athena.WorkGroupState
    The state of the workgroup: ENABLED or DISABLED.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    WorkGroupConfiguration Pulumi.AwsNative.Athena.Outputs.WorkGroupConfiguration
    The workgroup configuration
    CreationTime string
    The date and time the workgroup was created.
    Description string
    The workgroup description.
    State WorkGroupStateEnum
    The state of the workgroup: ENABLED or DISABLED.
    Tags Tag
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    WorkGroupConfiguration WorkGroupConfiguration
    The workgroup configuration
    creationTime String
    The date and time the workgroup was created.
    description String
    The workgroup description.
    state WorkGroupState
    The state of the workgroup: ENABLED or DISABLED.
    tags List<Tag>
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    workGroupConfiguration WorkGroupConfiguration
    The workgroup configuration
    creationTime string
    The date and time the workgroup was created.
    description string
    The workgroup description.
    state WorkGroupState
    The state of the workgroup: ENABLED or DISABLED.
    tags Tag[]
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    workGroupConfiguration WorkGroupConfiguration
    The workgroup configuration
    creation_time str
    The date and time the workgroup was created.
    description str
    The workgroup description.
    state WorkGroupState
    The state of the workgroup: ENABLED or DISABLED.
    tags Sequence[root_Tag]
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    work_group_configuration WorkGroupConfiguration
    The workgroup configuration
    creationTime 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.
    tags List<Property Map>
    One or more tags, separated by commas, that you want to attach to the workgroup as you create it
    workGroupConfiguration Property Map
    The workgroup configuration

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkGroupAclConfiguration

    S3AclOption Pulumi.AwsNative.Athena.WorkGroupS3AclOption
    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 .
    S3AclOption WorkGroupS3AclOption
    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 .
    s3AclOption WorkGroupS3AclOption
    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 .
    s3AclOption WorkGroupS3AclOption
    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_option WorkGroupS3AclOption
    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 .
    s3AclOption "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 .

    WorkGroupConfiguration

    AdditionalConfiguration string
    Specifies a user defined JSON string that is passed to the session engine.
    BytesScannedCutoffPerQuery int

    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.

    CustomerContentEncryptionConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupCustomerContentEncryptionConfiguration
    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.
    EnforceWorkGroupConfiguration bool
    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 .
    EngineVersion Pulumi.AwsNative.Athena.Inputs.WorkGroupEngineVersion
    The engine version that all queries running on the workgroup use.
    ExecutionRole string
    Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
    PublishCloudWatchMetricsEnabled bool
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    RequesterPaysEnabled bool
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    ResultConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupResultConfiguration
    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 .
    AdditionalConfiguration string
    Specifies a user defined JSON string that is passed to the session engine.
    BytesScannedCutoffPerQuery int

    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.

    CustomerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
    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.
    EnforceWorkGroupConfiguration bool
    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 .
    EngineVersion WorkGroupEngineVersion
    The engine version that all queries running on the workgroup use.
    ExecutionRole string
    Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
    PublishCloudWatchMetricsEnabled bool
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    RequesterPaysEnabled bool
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    ResultConfiguration WorkGroupResultConfiguration
    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 .
    additionalConfiguration String
    Specifies a user defined JSON string that is passed to the session engine.
    bytesScannedCutoffPerQuery Integer

    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.

    customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
    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.
    enforceWorkGroupConfiguration Boolean
    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 .
    engineVersion WorkGroupEngineVersion
    The engine version that all queries running on the workgroup use.
    executionRole String
    Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
    publishCloudWatchMetricsEnabled Boolean
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    requesterPaysEnabled Boolean
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    resultConfiguration WorkGroupResultConfiguration
    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 .
    additionalConfiguration string
    Specifies a user defined JSON string that is passed to the session engine.
    bytesScannedCutoffPerQuery number

    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.

    customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
    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.
    enforceWorkGroupConfiguration boolean
    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 .
    engineVersion WorkGroupEngineVersion
    The engine version that all queries running on the workgroup use.
    executionRole string
    Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
    publishCloudWatchMetricsEnabled boolean
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    requesterPaysEnabled boolean
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    resultConfiguration WorkGroupResultConfiguration
    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_cutoff_per_query int

    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_encryption_configuration WorkGroupCustomerContentEncryptionConfiguration
    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_group_configuration bool
    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_version WorkGroupEngineVersion
    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.
    publish_cloud_watch_metrics_enabled bool
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    requester_pays_enabled bool
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    result_configuration WorkGroupResultConfiguration
    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 .
    additionalConfiguration String
    Specifies a user defined JSON string that is passed to the session engine.
    bytesScannedCutoffPerQuery Number

    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.

    customerContentEncryptionConfiguration Property Map
    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.
    enforceWorkGroupConfiguration Boolean
    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 .
    engineVersion Property Map
    The engine version that all queries running on the workgroup use.
    executionRole String
    Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
    publishCloudWatchMetricsEnabled Boolean
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    requesterPaysEnabled Boolean
    If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
    resultConfiguration 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

    KmsKey string
    The customer managed KMS key that is used to encrypt the user's data stores in Athena.
    KmsKey string
    The customer managed KMS key that is used to encrypt the user's data stores in Athena.
    kmsKey String
    The customer managed KMS key that is used to encrypt the user's data stores in Athena.
    kmsKey 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.
    kmsKey String
    The customer managed KMS key that is used to encrypt the user's data stores in Athena.

    WorkGroupEncryptionConfiguration

    EncryptionOption Pulumi.AwsNative.Athena.WorkGroupEncryptionOption

    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.

    KmsKey string
    For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.
    EncryptionOption WorkGroupEncryptionOption

    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.

    KmsKey string
    For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.
    encryptionOption WorkGroupEncryptionOption

    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.

    kmsKey String
    For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.
    encryptionOption WorkGroupEncryptionOption

    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.

    kmsKey string
    For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.
    encryption_option WorkGroupEncryptionOption

    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_KMS and CSE_KMS , this is the KMS key ARN or ID.
    encryptionOption "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.

    kmsKey String
    For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.

    WorkGroupEncryptionOption

    WorkGroupEngineVersion

    EffectiveEngineVersion string
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    SelectedEngineVersion string
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.
    EffectiveEngineVersion string
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    SelectedEngineVersion string
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.
    effectiveEngineVersion String
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    selectedEngineVersion String
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.
    effectiveEngineVersion string
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    selectedEngineVersion string
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.
    effective_engine_version str
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    selected_engine_version str
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.
    effectiveEngineVersion String
    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 CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
    selectedEngineVersion String
    The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.

    WorkGroupResultConfiguration

    AclConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupAclConfiguration
    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. See EnforceWorkGroupConfiguration .
    EncryptionConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupEncryptionConfiguration
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    ExpectedBucketOwner string

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    OutputLocation 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 and EnforceWorkGroupConfiguration .
    AclConfiguration WorkGroupAclConfiguration
    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. See EnforceWorkGroupConfiguration .
    EncryptionConfiguration WorkGroupEncryptionConfiguration
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    ExpectedBucketOwner string

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    OutputLocation 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 and EnforceWorkGroupConfiguration .
    aclConfiguration WorkGroupAclConfiguration
    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. See EnforceWorkGroupConfiguration .
    encryptionConfiguration WorkGroupEncryptionConfiguration
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    expectedBucketOwner String

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    outputLocation 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 and EnforceWorkGroupConfiguration .
    aclConfiguration WorkGroupAclConfiguration
    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. See EnforceWorkGroupConfiguration .
    encryptionConfiguration WorkGroupEncryptionConfiguration
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    expectedBucketOwner string

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    outputLocation 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 and EnforceWorkGroupConfiguration .
    acl_configuration WorkGroupAclConfiguration
    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. See EnforceWorkGroupConfiguration .
    encryption_configuration WorkGroupEncryptionConfiguration
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    expected_bucket_owner str

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    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 and EnforceWorkGroupConfiguration .
    aclConfiguration 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. See EnforceWorkGroupConfiguration .
    encryptionConfiguration Property Map
    If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_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. See EnforceWorkGroupConfiguration and Override client-side settings .
    expectedBucketOwner String

    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 for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

    outputLocation 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 and EnforceWorkGroupConfiguration .

    WorkGroupS3AclOption

    WorkGroupState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native