Class CfnDatasetGroup
A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions).
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Personalize
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDatasetGroup : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDatasetGroup
Inherits CfnResource
Implements IInspectable
Remarks
You create a dataset group by calling CreateDatasetGroup . You then create a dataset and add it to a dataset group by calling CreateDataset . The dataset group is used to create and train a solution by calling CreateSolution . A dataset group can contain only one of each type of dataset.
You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.
CloudformationResource: AWS::Personalize::DatasetGroup
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.Personalize;
var cfnDatasetGroup = new CfnDatasetGroup(this, "MyCfnDatasetGroup", new CfnDatasetGroupProps {
Name = "name",
// the properties below are optional
Domain = "domain",
KmsKeyArn = "kmsKeyArn",
RoleArn = "roleArn"
});
Synopsis
Constructors
CfnDatasetGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDatasetGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDatasetGroup(Construct, String, ICfnDatasetGroupProps) |
Properties
AttrDatasetGroupArn | The Amazon Resource Name (ARN) of the dataset group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Domain | The domain of a Domain dataset group. |
KmsKeyArn | The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets. |
Name | The name of the dataset group. |
RoleArn | The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDatasetGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDatasetGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDatasetGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDatasetGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDatasetGroup(Construct, String, ICfnDatasetGroupProps)
public CfnDatasetGroup(Construct scope, string id, ICfnDatasetGroupProps 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 ICfnDatasetGroupProps
Resource properties.
Properties
AttrDatasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
public virtual string AttrDatasetGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DatasetGroupArn
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
Domain
The domain of a Domain dataset group.
public virtual string Domain { get; set; }
Property Value
System.String
KmsKeyArn
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.
public virtual string KmsKeyArn { get; set; }
Property Value
System.String
Name
The name of the dataset group.
public virtual string Name { get; set; }
Property Value
System.String
RoleArn
The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key.
public virtual string RoleArn { get; set; }
Property Value
System.String
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>