Documentation ¶
Index ¶
- func CfnTrainingDataset_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrainingDataset_IsCfnElement(x interface{}) *bool
- func CfnTrainingDataset_IsCfnResource(x interface{}) *bool
- func CfnTrainingDataset_IsConstruct(x interface{}) *bool
- func NewCfnTrainingDataset_Override(c CfnTrainingDataset, scope constructs.Construct, id *string, ...)
- type CfnTrainingDataset
- type CfnTrainingDatasetProps
- type CfnTrainingDataset_ColumnSchemaProperty
- type CfnTrainingDataset_DataSourceProperty
- type CfnTrainingDataset_DatasetInputConfigProperty
- type CfnTrainingDataset_DatasetProperty
- type CfnTrainingDataset_GlueDataSourceProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnTrainingDataset_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrainingDataset_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrainingDataset_IsCfnElement ¶
func CfnTrainingDataset_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTrainingDataset_IsCfnResource ¶
func CfnTrainingDataset_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrainingDataset_IsConstruct ¶
func CfnTrainingDataset_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnTrainingDataset_Override ¶
func NewCfnTrainingDataset_Override(c CfnTrainingDataset, scope constructs.Construct, id *string, props *CfnTrainingDatasetProps)
Types ¶
type CfnTrainingDataset ¶
type CfnTrainingDataset interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The status of the training dataset. AttrStatus() *string // The Amazon Resource Name (ARN) of the training dataset. AttrTrainingDatasetArn() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the training dataset. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the training dataset. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the `dataSource` field of each dataset. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The optional metadata that you apply to the resource to help you categorize and organize them. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. TrainingData() interface{} SetTrainingData(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Defines the information necessary to create a training dataset.
In Clean Rooms ML, the `TrainingDataset` is metadata that points to a Glue table, which is read only during `AudienceModel` creation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTrainingDataset := awscdk.Aws_cleanroomsml.NewCfnTrainingDataset(this, jsii.String("MyCfnTrainingDataset"), &CfnTrainingDatasetProps{ Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), TrainingData: []interface{}{ &DatasetProperty{ InputConfig: &DatasetInputConfigProperty{ DataSource: &DataSourceProperty{ GlueDataSource: &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }, }, Schema: []interface{}{ &ColumnSchemaProperty{ ColumnName: jsii.String("columnName"), ColumnTypes: []*string{ jsii.String("columnTypes"), }, }, }, }, Type: jsii.String("type"), }, }, // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnTrainingDataset ¶
func NewCfnTrainingDataset(scope constructs.Construct, id *string, props *CfnTrainingDatasetProps) CfnTrainingDataset
type CfnTrainingDatasetProps ¶
type CfnTrainingDatasetProps struct { // The name of the training dataset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-name // Name *string `field:"required" json:"name" yaml:"name"` // The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the `dataSource` field of each dataset. // // Passing a role across accounts is not allowed. If you pass a role that isn't in your account, you get an `AccessDeniedException` error. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. // // You must provide a role that has read access to these tables. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-trainingdata // TrainingData interface{} `field:"required" json:"trainingData" yaml:"trainingData"` // The description of the training dataset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-description // Description *string `field:"optional" json:"description" yaml:"description"` // The optional metadata that you apply to the resource to help you categorize and organize them. // // Each tag consists of a key and an optional value, both of which you define. // // The following basic restrictions apply to tags: // // - Maximum number of tags per resource - 50. // - For each resource, each tag key must be unique, and each tag key can have only one value. // - Maximum key length - 128 Unicode characters in UTF-8. // - Maximum value length - 256 Unicode characters in UTF-8. // - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTrainingDataset`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTrainingDatasetProps := &CfnTrainingDatasetProps{ Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), TrainingData: []interface{}{ &DatasetProperty{ InputConfig: &DatasetInputConfigProperty{ DataSource: &DataSourceProperty{ GlueDataSource: &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }, }, Schema: []interface{}{ &ColumnSchemaProperty{ ColumnName: jsii.String("columnName"), ColumnTypes: []*string{ jsii.String("columnTypes"), }, }, }, }, Type: jsii.String("type"), }, }, // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnTrainingDataset_ColumnSchemaProperty ¶
type CfnTrainingDataset_ColumnSchemaProperty struct { // The name of a column. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-columnschema.html#cfn-cleanroomsml-trainingdataset-columnschema-columnname // ColumnName *string `field:"required" json:"columnName" yaml:"columnName"` // The data type of column. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-columnschema.html#cfn-cleanroomsml-trainingdataset-columnschema-columntypes // ColumnTypes *[]*string `field:"required" json:"columnTypes" yaml:"columnTypes"` }
Metadata for a column.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" columnSchemaProperty := &ColumnSchemaProperty{ ColumnName: jsii.String("columnName"), ColumnTypes: []*string{ jsii.String("columnTypes"), }, }
type CfnTrainingDataset_DataSourceProperty ¶
type CfnTrainingDataset_DataSourceProperty struct { // A GlueDataSource object that defines the catalog ID, database name, and table name for the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasource.html#cfn-cleanroomsml-trainingdataset-datasource-gluedatasource // GlueDataSource interface{} `field:"required" json:"glueDataSource" yaml:"glueDataSource"` }
Defines information about the Glue data source that contains the training data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataSourceProperty := &DataSourceProperty{ GlueDataSource: &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }, }
type CfnTrainingDataset_DatasetInputConfigProperty ¶
type CfnTrainingDataset_DatasetInputConfigProperty struct { // A DataSource object that specifies the Glue data source for the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html#cfn-cleanroomsml-trainingdataset-datasetinputconfig-datasource // DataSource interface{} `field:"required" json:"dataSource" yaml:"dataSource"` // The schema information for the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-datasetinputconfig.html#cfn-cleanroomsml-trainingdataset-datasetinputconfig-schema // Schema interface{} `field:"required" json:"schema" yaml:"schema"` }
Defines the Glue data source and schema mapping information.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetInputConfigProperty := &DatasetInputConfigProperty{ DataSource: &DataSourceProperty{ GlueDataSource: &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }, }, Schema: []interface{}{ &ColumnSchemaProperty{ ColumnName: jsii.String("columnName"), ColumnTypes: []*string{ jsii.String("columnTypes"), }, }, }, }
type CfnTrainingDataset_DatasetProperty ¶
type CfnTrainingDataset_DatasetProperty struct { // A DatasetInputConfig object that defines the data source and schema mapping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-dataset.html#cfn-cleanroomsml-trainingdataset-dataset-inputconfig // InputConfig interface{} `field:"required" json:"inputConfig" yaml:"inputConfig"` // What type of information is found in the dataset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-dataset.html#cfn-cleanroomsml-trainingdataset-dataset-type // Type *string `field:"required" json:"type" yaml:"type"` }
Defines where the training dataset is located, what type of data it contains, and how to access the data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" datasetProperty := &DatasetProperty{ InputConfig: &DatasetInputConfigProperty{ DataSource: &DataSourceProperty{ GlueDataSource: &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }, }, Schema: []interface{}{ &ColumnSchemaProperty{ ColumnName: jsii.String("columnName"), ColumnTypes: []*string{ jsii.String("columnTypes"), }, }, }, }, Type: jsii.String("type"), }
type CfnTrainingDataset_GlueDataSourceProperty ¶
type CfnTrainingDataset_GlueDataSourceProperty struct { // The Glue database that contains the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The Glue table that contains the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // The Glue catalog that contains the training data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanroomsml-trainingdataset-gluedatasource.html#cfn-cleanroomsml-trainingdataset-gluedatasource-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` }
Defines the Glue data source that contains the training data.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" glueDataSourceProperty := &GlueDataSourceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), }
Source Files ¶
- CfnTrainingDataset.go
- CfnTrainingDatasetProps.go
- CfnTrainingDataset_ColumnSchemaProperty.go
- CfnTrainingDataset_DataSourceProperty.go
- CfnTrainingDataset_DatasetInputConfigProperty.go
- CfnTrainingDataset_DatasetProperty.go
- CfnTrainingDataset_GlueDataSourceProperty.go
- CfnTrainingDataset__checks.go
- main.go