software.amazon.awscdk.services.personalize

Class CfnDatasetGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.personalize.CfnDatasetGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:49.453Z")
public class CfnDatasetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Personalize::DatasetGroup`.

A dataset group is a collection of related datasets (Interactions, User, and Item). 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.personalize.*;
 CfnDatasetGroup cfnDatasetGroup = CfnDatasetGroup.Builder.create(this, "MyCfnDatasetGroup")
         .name("name")
         // the properties below are optional
         .domain("domain")
         .kmsKeyArn("kmsKeyArn")
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDatasetGroup.Builder A fluent builder for CfnDatasetGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDatasetGroup(Construct scope, java.lang.String id, CfnDatasetGroupProps props) Create a new `AWS::Personalize::DatasetGroup`.
protected	CfnDatasetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDatasetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrDatasetGroupArn() The Amazon Resource Name (ARN) of the dataset group.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDomain() The domain of a Domain dataset group.
java.lang.String	getKmsKeyArn() The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.
java.lang.String	getName() The name of the dataset group.
java.lang.String	getRoleArn() The ARN of the IAM role that has permissions to create the dataset group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDomain(java.lang.String value) The domain of a Domain dataset group.
void	setKmsKeyArn(java.lang.String value) The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.
void	setName(java.lang.String value) The name of the dataset group.
void	setRoleArn(java.lang.String value) The ARN of the IAM role that has permissions to create the dataset group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDatasetGroup

protected CfnDatasetGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnDatasetGroup

protected CfnDatasetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDatasetGroup

public CfnDatasetGroup(Construct scope,
                       java.lang.String id,
                       CfnDatasetGroupProps props)

Create a new `AWS::Personalize::DatasetGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDatasetGroupArn

public java.lang.String getAttrDatasetGroupArn()

The Amazon Resource Name (ARN) of the dataset group.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.String getName()

The name of the dataset group.

setName

public void setName(java.lang.String value)

The name of the dataset group.

getDomain

public java.lang.String getDomain()

The domain of a Domain dataset group.

setDomain

public void setDomain(java.lang.String value)

The domain of a Domain dataset group.

getKmsKeyArn

public java.lang.String getKmsKeyArn()

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

setKmsKeyArn

public void setKmsKeyArn(java.lang.String value)

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

getRoleArn

public java.lang.String getRoleArn()

The ARN of the IAM role that has permissions to create the dataset group.

setRoleArn

public void setRoleArn(java.lang.String value)

The ARN of the IAM role that has permissions to create the dataset group.