Class CfnWorkGroup
A CloudFormation AWS::Athena::WorkGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.AWS.Athena.dll
Syntax (csharp)
public class CfnWorkGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWorkGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration
. 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 .
CloudformationResource: AWS::Athena::WorkGroup
Link: 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 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"
}
}
});
Synopsis
Constructors
CfnWorkGroup(Construct, String, ICfnWorkGroupProps) | Create a new |
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 |
Properties
AttrCreationTime | The date and time the workgroup was created, as a UNIX timestamp in seconds. |
AttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion | |
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 | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnWorkGroup(Construct, String, ICfnWorkGroupProps)
Create a new AWS::Athena::WorkGroup
.
public CfnWorkGroup(Construct scope, string id, ICfnWorkGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnWorkGroupProps
- resource properties.
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
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
public virtual string AttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion { get; }
Property Value
System.String
Remarks
CloudformationAttribute: WorkGroupConfiguration.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
Remarks
Name
The workgroup name.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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
Remarks
State
The state of the workgroup: ENABLED or DISABLED.
public virtual string State { get; set; }
Property Value
System.String
Remarks
Tags
The tags (key-value pairs) to associate with this resource.
public virtual TagManager Tags { get; }
Property Value
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.
public virtual object WorkGroupConfiguration { get; set; }
Property Value
System.Object
Remarks
The EnforceWorkGroupConfiguration
option determines whether workgroup settings override client-side query settings.
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>