Package software.amazon.awscdk.services.personalize

Class CfnDatasetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.708Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDatasetGroup

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

    • CfnDatasetGroup

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

    • CfnDatasetGroup

      @Stability(Stable) public CfnDatasetGroup(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDatasetGroupArn

      @Stability(Stable) @NotNull public String getAttrDatasetGroupArn()
      The Amazon Resource Name (ARN) of the dataset group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the dataset group.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the dataset group.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      The domain of a Domain dataset group.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      The domain of a Domain dataset group.

    • getKmsKeyArn

      @Stability(Stable) @Nullable public String getKmsKeyArn()
      The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

    • setKmsKeyArn

      @Stability(Stable) public void setKmsKeyArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The ARN of the IAM role that has permissions to create the dataset group.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The ARN of the IAM role that has permissions to create the dataset group.