Interface ICfnWorkGroupProps
Properties for defining a CfnWorkGroup
.
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnWorkGroupProps
Syntax (vb)
Public Interface ICfnWorkGroupProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html
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 cfnWorkGroupProps = new CfnWorkGroupProps {
Name = "name",
// the properties below are optional
Description = "description",
RecursiveDeleteOption = false,
State = "state",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
WorkGroupConfiguration = new WorkGroupConfigurationProperty {
AdditionalConfiguration = "additionalConfiguration",
BytesScannedCutoffPerQuery = 123,
CustomerContentEncryptionConfiguration = new CustomerContentEncryptionConfigurationProperty {
KmsKey = "kmsKey"
},
EnforceWorkGroupConfiguration = false,
EngineVersion = new EngineVersionProperty {
EffectiveEngineVersion = "effectiveEngineVersion",
SelectedEngineVersion = "selectedEngineVersion"
},
ExecutionRole = "executionRole",
PublishCloudWatchMetricsEnabled = false,
RequesterPaysEnabled = false,
ResultConfiguration = new ResultConfigurationProperty {
AclConfiguration = new AclConfigurationProperty {
S3AclOption = "s3AclOption"
},
EncryptionConfiguration = new EncryptionConfigurationProperty {
EncryptionOption = "encryptionOption",
// the properties below are optional
KmsKey = "kmsKey"
},
ExpectedBucketOwner = "expectedBucketOwner",
OutputLocation = "outputLocation"
}
},
WorkGroupConfigurationUpdates = new WorkGroupConfigurationUpdatesProperty {
AdditionalConfiguration = "additionalConfiguration",
BytesScannedCutoffPerQuery = 123,
CustomerContentEncryptionConfiguration = new CustomerContentEncryptionConfigurationProperty {
KmsKey = "kmsKey"
},
EnforceWorkGroupConfiguration = false,
EngineVersion = new EngineVersionProperty {
EffectiveEngineVersion = "effectiveEngineVersion",
SelectedEngineVersion = "selectedEngineVersion"
},
ExecutionRole = "executionRole",
PublishCloudWatchMetricsEnabled = false,
RemoveBytesScannedCutoffPerQuery = false,
RemoveCustomerContentEncryptionConfiguration = false,
RequesterPaysEnabled = false,
ResultConfigurationUpdates = 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
Properties
Description | The workgroup description. |
Name | The workgroup name. |
RecursiveDeleteOption | The option to delete a workgroup and its contents even if the workgroup contains any named queries. |
State | The state of the workgroup: ENABLED or DISABLED. |
Tags | The tags (key-value pairs) to associate with this resource. |
WorkGroupConfiguration | The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. |
WorkGroupConfigurationUpdates | (deprecated) The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified. |
Properties
Description
The workgroup description.
virtual string Description { get; }
Property Value
System.String
Remarks
Name
The workgroup name.
string Name { get; }
Property Value
System.String
Remarks
RecursiveDeleteOption
The option to delete a workgroup and its contents even if the workgroup contains any named queries.
virtual object RecursiveDeleteOption { get; }
Property Value
System.Object
Remarks
State
The state of the workgroup: ENABLED or DISABLED.
virtual string State { get; }
Property Value
System.String
Remarks
Tags
The tags (key-value pairs) to associate with this resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
WorkGroupConfiguration
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
virtual object WorkGroupConfiguration { get; }
Property Value
System.Object
Remarks
The EnforceWorkGroupConfiguration
option determines whether workgroup settings override client-side query settings.
WorkGroupConfigurationUpdates
(deprecated) The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
virtual object WorkGroupConfigurationUpdates { get; }
Property Value
System.Object