Documentation ¶
Index ¶
- func CfnDatasetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDatasetGroup_IsCfnElement(x interface{}) *bool
- func CfnDatasetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDatasetGroup_IsConstruct(x interface{}) *bool
- func CfnDataset_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataset_IsCfnElement(x interface{}) *bool
- func CfnDataset_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataset_IsConstruct(x interface{}) *bool
- func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchema_IsCfnElement(x interface{}) *bool
- func CfnSchema_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSchema_IsConstruct(x interface{}) *bool
- func CfnSolution_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSolution_IsCfnElement(x interface{}) *bool
- func CfnSolution_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSolution_IsConstruct(x interface{}) *bool
- func NewCfnDatasetGroup_Override(c CfnDatasetGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnDataset_Override(c CfnDataset, scope awscdk.Construct, id *string, props *CfnDatasetProps)
- func NewCfnSchema_Override(c CfnSchema, scope awscdk.Construct, id *string, props *CfnSchemaProps)
- func NewCfnSolution_Override(c CfnSolution, scope awscdk.Construct, id *string, props *CfnSolutionProps)
- type CfnDataset
- type CfnDatasetGroup
- type CfnDatasetGroupProps
- type CfnDatasetProps
- type CfnDataset_DatasetImportJobProperty
- type CfnSchema
- type CfnSchemaProps
- type CfnSolution
- type CfnSolutionProps
- type CfnSolution_SolutionConfigProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDatasetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnDatasetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnDatasetGroup_IsCfnElement ¶
func CfnDatasetGroup_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. Experimental.
func CfnDatasetGroup_IsCfnResource ¶
func CfnDatasetGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDatasetGroup_IsConstruct ¶
func CfnDatasetGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDataset_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataset_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataset_IsCfnElement ¶
func CfnDataset_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. Experimental.
func CfnDataset_IsCfnResource ¶
func CfnDataset_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataset_IsConstruct ¶
func CfnDataset_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSchema_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchema_IsCfnElement ¶
func CfnSchema_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. Experimental.
func CfnSchema_IsCfnResource ¶
func CfnSchema_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSchema_IsConstruct ¶
func CfnSchema_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSolution_CFN_RESOURCE_TYPE_NAME ¶
func CfnSolution_CFN_RESOURCE_TYPE_NAME() *string
func CfnSolution_IsCfnElement ¶
func CfnSolution_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. Experimental.
func CfnSolution_IsCfnResource ¶
func CfnSolution_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSolution_IsConstruct ¶
func CfnSolution_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDatasetGroup_Override ¶
func NewCfnDatasetGroup_Override(c CfnDatasetGroup, scope awscdk.Construct, id *string, props *CfnDatasetGroupProps)
Create a new `AWS::Personalize::DatasetGroup`.
func NewCfnDataset_Override ¶
func NewCfnDataset_Override(c CfnDataset, scope awscdk.Construct, id *string, props *CfnDatasetProps)
Create a new `AWS::Personalize::Dataset`.
func NewCfnSchema_Override ¶
func NewCfnSchema_Override(c CfnSchema, scope awscdk.Construct, id *string, props *CfnSchemaProps)
Create a new `AWS::Personalize::Schema`.
func NewCfnSolution_Override ¶
func NewCfnSolution_Override(c CfnSolution, scope awscdk.Construct, id *string, props *CfnSolutionProps)
Create a new `AWS::Personalize::Solution`.
Types ¶
type CfnDataset ¶
type CfnDataset interface { awscdk.CfnResource awscdk.IInspectable AttrDatasetArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::Personalize::Dataset.DatasetGroupArn`. DatasetGroupArn() *string SetDatasetGroupArn(val *string) // `AWS::Personalize::Dataset.DatasetImportJob`. DatasetImportJob() interface{} SetDatasetImportJob(val interface{}) // `AWS::Personalize::Dataset.DatasetType`. DatasetType() *string SetDatasetType(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. // Experimental. LogicalId() *string // `AWS::Personalize::Dataset.Name`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // `AWS::Personalize::Dataset.SchemaArn`. SchemaArn() *string SetSchemaArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Personalize::Dataset`.
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" var dataSource interface{} cfnDataset := awscdk.Aws_personalize.NewCfnDataset(this, jsii.String("MyCfnDataset"), &cfnDatasetProps{ datasetGroupArn: jsii.String("datasetGroupArn"), datasetType: jsii.String("datasetType"), name: jsii.String("name"), schemaArn: jsii.String("schemaArn"), // the properties below are optional datasetImportJob: &datasetImportJobProperty{ datasetArn: jsii.String("datasetArn"), datasetImportJobArn: jsii.String("datasetImportJobArn"), dataSource: dataSource, jobName: jsii.String("jobName"), roleArn: jsii.String("roleArn"), }, })
func NewCfnDataset ¶
func NewCfnDataset(scope awscdk.Construct, id *string, props *CfnDatasetProps) CfnDataset
Create a new `AWS::Personalize::Dataset`.
type CfnDatasetGroup ¶
type CfnDatasetGroup interface { awscdk.CfnResource awscdk.IInspectable AttrDatasetGroupArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::Personalize::DatasetGroup.Domain`. Domain() *string SetDomain(val *string) // `AWS::Personalize::DatasetGroup.KmsKeyArn`. KmsKeyArn() *string SetKmsKeyArn(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. // Experimental. LogicalId() *string // `AWS::Personalize::DatasetGroup.Name`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // `AWS::Personalize::DatasetGroup.RoleArn`. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Personalize::DatasetGroup`.
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" cfnDatasetGroup := awscdk.Aws_personalize.NewCfnDatasetGroup(this, jsii.String("MyCfnDatasetGroup"), &cfnDatasetGroupProps{ name: jsii.String("name"), // the properties below are optional domain: jsii.String("domain"), kmsKeyArn: jsii.String("kmsKeyArn"), roleArn: jsii.String("roleArn"), })
func NewCfnDatasetGroup ¶
func NewCfnDatasetGroup(scope awscdk.Construct, id *string, props *CfnDatasetGroupProps) CfnDatasetGroup
Create a new `AWS::Personalize::DatasetGroup`.
type CfnDatasetGroupProps ¶
type CfnDatasetGroupProps struct { // `AWS::Personalize::DatasetGroup.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::Personalize::DatasetGroup.Domain`. Domain *string `field:"optional" json:"domain" yaml:"domain"` // `AWS::Personalize::DatasetGroup.KmsKeyArn`. KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` // `AWS::Personalize::DatasetGroup.RoleArn`. RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
Properties for defining a `CfnDatasetGroup`.
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" cfnDatasetGroupProps := &cfnDatasetGroupProps{ name: jsii.String("name"), // the properties below are optional domain: jsii.String("domain"), kmsKeyArn: jsii.String("kmsKeyArn"), roleArn: jsii.String("roleArn"), }
type CfnDatasetProps ¶
type CfnDatasetProps struct { // `AWS::Personalize::Dataset.DatasetGroupArn`. DatasetGroupArn *string `field:"required" json:"datasetGroupArn" yaml:"datasetGroupArn"` // `AWS::Personalize::Dataset.DatasetType`. DatasetType *string `field:"required" json:"datasetType" yaml:"datasetType"` // `AWS::Personalize::Dataset.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::Personalize::Dataset.SchemaArn`. SchemaArn *string `field:"required" json:"schemaArn" yaml:"schemaArn"` // `AWS::Personalize::Dataset.DatasetImportJob`. DatasetImportJob interface{} `field:"optional" json:"datasetImportJob" yaml:"datasetImportJob"` }
Properties for defining a `CfnDataset`.
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" var dataSource interface{} cfnDatasetProps := &cfnDatasetProps{ datasetGroupArn: jsii.String("datasetGroupArn"), datasetType: jsii.String("datasetType"), name: jsii.String("name"), schemaArn: jsii.String("schemaArn"), // the properties below are optional datasetImportJob: &datasetImportJobProperty{ datasetArn: jsii.String("datasetArn"), datasetImportJobArn: jsii.String("datasetImportJobArn"), dataSource: dataSource, jobName: jsii.String("jobName"), roleArn: jsii.String("roleArn"), }, }
type CfnDataset_DatasetImportJobProperty ¶
type CfnDataset_DatasetImportJobProperty struct { // `CfnDataset.DatasetImportJobProperty.DatasetArn`. DatasetArn *string `field:"optional" json:"datasetArn" yaml:"datasetArn"` // `CfnDataset.DatasetImportJobProperty.DatasetImportJobArn`. DatasetImportJobArn *string `field:"optional" json:"datasetImportJobArn" yaml:"datasetImportJobArn"` // `CfnDataset.DatasetImportJobProperty.DataSource`. DataSource interface{} `field:"optional" json:"dataSource" yaml:"dataSource"` // `CfnDataset.DatasetImportJobProperty.JobName`. JobName *string `field:"optional" json:"jobName" yaml:"jobName"` // `CfnDataset.DatasetImportJobProperty.RoleArn`. RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
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" var dataSource interface{} datasetImportJobProperty := &datasetImportJobProperty{ datasetArn: jsii.String("datasetArn"), datasetImportJobArn: jsii.String("datasetImportJobArn"), dataSource: dataSource, jobName: jsii.String("jobName"), roleArn: jsii.String("roleArn"), }
type CfnSchema ¶
type CfnSchema interface { awscdk.CfnResource awscdk.IInspectable AttrSchemaArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::Personalize::Schema.Domain`. Domain() *string SetDomain(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. // Experimental. LogicalId() *string // `AWS::Personalize::Schema.Name`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // `AWS::Personalize::Schema.Schema`. Schema() *string SetSchema(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Personalize::Schema`.
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" cfnSchema := awscdk.Aws_personalize.NewCfnSchema(this, jsii.String("MyCfnSchema"), &cfnSchemaProps{ name: jsii.String("name"), schema: jsii.String("schema"), // the properties below are optional domain: jsii.String("domain"), })
func NewCfnSchema ¶
func NewCfnSchema(scope awscdk.Construct, id *string, props *CfnSchemaProps) CfnSchema
Create a new `AWS::Personalize::Schema`.
type CfnSchemaProps ¶
type CfnSchemaProps struct { // `AWS::Personalize::Schema.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::Personalize::Schema.Schema`. Schema *string `field:"required" json:"schema" yaml:"schema"` // `AWS::Personalize::Schema.Domain`. Domain *string `field:"optional" json:"domain" yaml:"domain"` }
Properties for defining a `CfnSchema`.
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" cfnSchemaProps := &cfnSchemaProps{ name: jsii.String("name"), schema: jsii.String("schema"), // the properties below are optional domain: jsii.String("domain"), }
type CfnSolution ¶
type CfnSolution interface { awscdk.CfnResource awscdk.IInspectable AttrSolutionArn() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::Personalize::Solution.DatasetGroupArn`. DatasetGroupArn() *string SetDatasetGroupArn(val *string) // `AWS::Personalize::Solution.EventType`. EventType() *string SetEventType(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. // Experimental. LogicalId() *string // `AWS::Personalize::Solution.Name`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // `AWS::Personalize::Solution.PerformAutoML`. PerformAutoMl() interface{} SetPerformAutoMl(val interface{}) // `AWS::Personalize::Solution.PerformHPO`. PerformHpo() interface{} SetPerformHpo(val interface{}) // `AWS::Personalize::Solution.RecipeArn`. RecipeArn() *string SetRecipeArn(val *string) // 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 })`. // Experimental. Ref() *string // `AWS::Personalize::Solution.SolutionConfig`. SolutionConfig() interface{} SetSolutionConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Personalize::Solution`.
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" var autoMlConfig interface{} var hpoConfig interface{} cfnSolution := awscdk.Aws_personalize.NewCfnSolution(this, jsii.String("MyCfnSolution"), &cfnSolutionProps{ datasetGroupArn: jsii.String("datasetGroupArn"), name: jsii.String("name"), // the properties below are optional eventType: jsii.String("eventType"), performAutoMl: jsii.Boolean(false), performHpo: jsii.Boolean(false), recipeArn: jsii.String("recipeArn"), solutionConfig: &solutionConfigProperty{ algorithmHyperParameters: map[string]*string{ "algorithmHyperParametersKey": jsii.String("algorithmHyperParameters"), }, autoMlConfig: autoMlConfig, eventValueThreshold: jsii.String("eventValueThreshold"), featureTransformationParameters: map[string]*string{ "featureTransformationParametersKey": jsii.String("featureTransformationParameters"), }, hpoConfig: hpoConfig, }, })
func NewCfnSolution ¶
func NewCfnSolution(scope awscdk.Construct, id *string, props *CfnSolutionProps) CfnSolution
Create a new `AWS::Personalize::Solution`.
type CfnSolutionProps ¶
type CfnSolutionProps struct { // `AWS::Personalize::Solution.DatasetGroupArn`. DatasetGroupArn *string `field:"required" json:"datasetGroupArn" yaml:"datasetGroupArn"` // `AWS::Personalize::Solution.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::Personalize::Solution.EventType`. EventType *string `field:"optional" json:"eventType" yaml:"eventType"` // `AWS::Personalize::Solution.PerformAutoML`. PerformAutoMl interface{} `field:"optional" json:"performAutoMl" yaml:"performAutoMl"` // `AWS::Personalize::Solution.PerformHPO`. PerformHpo interface{} `field:"optional" json:"performHpo" yaml:"performHpo"` // `AWS::Personalize::Solution.RecipeArn`. RecipeArn *string `field:"optional" json:"recipeArn" yaml:"recipeArn"` // `AWS::Personalize::Solution.SolutionConfig`. SolutionConfig interface{} `field:"optional" json:"solutionConfig" yaml:"solutionConfig"` }
Properties for defining a `CfnSolution`.
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" var autoMlConfig interface{} var hpoConfig interface{} cfnSolutionProps := &cfnSolutionProps{ datasetGroupArn: jsii.String("datasetGroupArn"), name: jsii.String("name"), // the properties below are optional eventType: jsii.String("eventType"), performAutoMl: jsii.Boolean(false), performHpo: jsii.Boolean(false), recipeArn: jsii.String("recipeArn"), solutionConfig: &solutionConfigProperty{ algorithmHyperParameters: map[string]*string{ "algorithmHyperParametersKey": jsii.String("algorithmHyperParameters"), }, autoMlConfig: autoMlConfig, eventValueThreshold: jsii.String("eventValueThreshold"), featureTransformationParameters: map[string]*string{ "featureTransformationParametersKey": jsii.String("featureTransformationParameters"), }, hpoConfig: hpoConfig, }, }
type CfnSolution_SolutionConfigProperty ¶
type CfnSolution_SolutionConfigProperty struct { // `CfnSolution.SolutionConfigProperty.AlgorithmHyperParameters`. AlgorithmHyperParameters interface{} `field:"optional" json:"algorithmHyperParameters" yaml:"algorithmHyperParameters"` // `CfnSolution.SolutionConfigProperty.AutoMLConfig`. AutoMlConfig interface{} `field:"optional" json:"autoMlConfig" yaml:"autoMlConfig"` // `CfnSolution.SolutionConfigProperty.EventValueThreshold`. EventValueThreshold *string `field:"optional" json:"eventValueThreshold" yaml:"eventValueThreshold"` // `CfnSolution.SolutionConfigProperty.FeatureTransformationParameters`. FeatureTransformationParameters interface{} `field:"optional" json:"featureTransformationParameters" yaml:"featureTransformationParameters"` // `CfnSolution.SolutionConfigProperty.HpoConfig`. HpoConfig interface{} `field:"optional" json:"hpoConfig" yaml:"hpoConfig"` }
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" var autoMlConfig interface{} var hpoConfig interface{} solutionConfigProperty := &solutionConfigProperty{ algorithmHyperParameters: map[string]*string{ "algorithmHyperParametersKey": jsii.String("algorithmHyperParameters"), }, autoMlConfig: autoMlConfig, eventValueThreshold: jsii.String("eventValueThreshold"), featureTransformationParameters: map[string]*string{ "featureTransformationParametersKey": jsii.String("featureTransformationParameters"), }, hpoConfig: hpoConfig, }