Class CfnWorkGroup
The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration
.
Inherited Members
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWorkGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnWorkGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Each workgroup enables you to isolate queries for you or your group from other queries in the same account. For more information, see CreateWorkGroup in the Amazon Athena API Reference .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html
CloudformationResource: AWS::Athena::WorkGroup
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 cfnWorkGroup = new CfnWorkGroup(this, "MyCfnWorkGroup", 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
Constructors
CfnWorkGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWorkGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnWorkGroup(Construct, String, ICfnWorkGroupProps) |
Properties
AttrCreationTime | The date and time the workgroup was created, as a UNIX timestamp in seconds. |
AttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion | Read only. |
AttrWorkGroupConfigurationUpdatesEngineVersionEffectiveEngineVersion | Read only. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnWorkGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWorkGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWorkGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWorkGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnWorkGroup(Construct, String, ICfnWorkGroupProps)
public CfnWorkGroup(Construct scope, string id, ICfnWorkGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnWorkGroupProps
Resource properties.
Properties
AttrCreationTime
The date and time the workgroup was created, as a UNIX timestamp in seconds.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
For example: 1582761016
.
CloudformationAttribute: CreationTime
AttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion
Read only.
public virtual string AttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion { get; }
Property Value
System.String
Remarks
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.
CloudformationAttribute: WorkGroupConfiguration.EngineVersion.EffectiveEngineVersion
AttrWorkGroupConfigurationUpdatesEngineVersionEffectiveEngineVersion
Read only.
public virtual string AttrWorkGroupConfigurationUpdatesEngineVersionEffectiveEngineVersion { get; }
Property Value
System.String
Remarks
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.
CloudformationAttribute: WorkGroupConfigurationUpdates.EngineVersion.EffectiveEngineVersion
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The workgroup description.
public virtual string Description { get; set; }
Property Value
System.String
Name
The workgroup name.
public virtual string Name { get; set; }
Property Value
System.String
RecursiveDeleteOption
The option to delete a workgroup and its contents even if the workgroup contains any named queries.
public virtual object RecursiveDeleteOption { get; set; }
Property Value
System.Object
State
The state of the workgroup: ENABLED or DISABLED.
public virtual string State { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags (key-value pairs) to associate with this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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.
public virtual object WorkGroupConfiguration { get; set; }
Property Value
System.Object
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.
public virtual object WorkGroupConfigurationUpdates { get; set; }
Property Value
System.Object
Remarks
Stability: Deprecated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>