Class CfnWorkGroup.ResultConfigurationUpdatesProperty
The information about the updates in the query results, such as output location and encryption configuration for the query results.
Inheritance
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ResultConfigurationUpdatesProperty : Object, CfnWorkGroup.IResultConfigurationUpdatesProperty
Syntax (vb)
Public Class ResultConfigurationUpdatesProperty
Inherits Object
Implements CfnWorkGroup.IResultConfigurationUpdatesProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;
var resultConfigurationUpdatesProperty = new ResultConfigurationUpdatesProperty {
AclConfiguration = new AclConfigurationProperty {
S3AclOption = "s3AclOption"
},
EncryptionConfiguration = new EncryptionConfigurationProperty {
EncryptionOption = "encryptionOption",
// the properties below are optional
KmsKey = "kmsKey"
},
ExpectedBucketOwner = "expectedBucketOwner",
OutputLocation = "outputLocation",
RemoveAclConfiguration = false,
RemoveEncryptionConfiguration = false,
RemoveExpectedBucketOwner = false,
RemoveOutputLocation = false
};
Synopsis
Constructors
ResultConfigurationUpdatesProperty() |
Properties
AclConfiguration | The ACL configuration for the query results. |
EncryptionConfiguration | The encryption configuration for the query results. |
ExpectedBucketOwner | The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by |
OutputLocation | The location in Amazon S3 where your query results are stored, such as |
RemoveAclConfiguration | If set to |
RemoveEncryptionConfiguration | If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. |
RemoveExpectedBucketOwner | If set to "true", removes the AWS account ID previously specified for |
RemoveOutputLocation | If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. |
Constructors
ResultConfigurationUpdatesProperty()
public ResultConfigurationUpdatesProperty()
Properties
AclConfiguration
The ACL configuration for the query results.
public object AclConfiguration { get; set; }
Property Value
System.Object
Remarks
EncryptionConfiguration
The encryption configuration for the query results.
public object EncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
ExpectedBucketOwner
The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation
.
public string ExpectedBucketOwner { get; set; }
Property Value
System.String
Remarks
If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner
AWS account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.
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 WorkGroupConfiguration$EnforceWorkGroupConfiguration
and Workgroup Settings Override Client-Side Settings .
OutputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/
.
public string OutputLocation { get; set; }
Property Value
System.String
Remarks
For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See EnforceWorkGroupConfiguration
.
RemoveAclConfiguration
If set to true
, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.
public object RemoveAclConfiguration { get; set; }
Property Value
System.Object
Remarks
If set to false
or not set, and a value is present in the AclConfiguration
of ResultConfigurationUpdates
, the AclConfiguration
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .
RemoveEncryptionConfiguration
If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.
public object RemoveEncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .
RemoveExpectedBucketOwner
If set to "true", removes the AWS account ID previously specified for ResultConfiguration$ExpectedBucketOwner
.
public object RemoveExpectedBucketOwner { get; set; }
Property Value
System.Object
Remarks
If set to "false" or not set, and a value is present in the ExpectedBucketOwner
in ResultConfigurationUpdates
(the client-side setting), the ExpectedBucketOwner
in the workgroup's ResultConfiguration
is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .
RemoveOutputLocation
If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.
public object RemoveOutputLocation { get; set; }
Property Value
System.Object
Remarks
If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .