Documentation ¶
Index ¶
- func CfnIdMappingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdMappingWorkflow_IsCfnElement(x interface{}) *bool
- func CfnIdMappingWorkflow_IsCfnResource(x interface{}) *bool
- func CfnIdMappingWorkflow_IsConstruct(x interface{}) *bool
- func CfnMatchingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchingWorkflow_IsCfnElement(x interface{}) *bool
- func CfnMatchingWorkflow_IsCfnResource(x interface{}) *bool
- func CfnMatchingWorkflow_IsConstruct(x interface{}) *bool
- func CfnSchemaMapping_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchemaMapping_IsCfnElement(x interface{}) *bool
- func CfnSchemaMapping_IsCfnResource(x interface{}) *bool
- func CfnSchemaMapping_IsConstruct(x interface{}) *bool
- func NewCfnIdMappingWorkflow_Override(c CfnIdMappingWorkflow, scope constructs.Construct, id *string, ...)
- func NewCfnMatchingWorkflow_Override(c CfnMatchingWorkflow, scope constructs.Construct, id *string, ...)
- func NewCfnSchemaMapping_Override(c CfnSchemaMapping, scope constructs.Construct, id *string, ...)
- type CfnIdMappingWorkflow
- type CfnIdMappingWorkflowProps
- type CfnIdMappingWorkflow_IdMappingTechniquesProperty
- type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty
- type CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty
- type CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty
- type CfnIdMappingWorkflow_ProviderPropertiesProperty
- type CfnMatchingWorkflow
- type CfnMatchingWorkflowProps
- type CfnMatchingWorkflow_InputSourceProperty
- type CfnMatchingWorkflow_IntermediateSourceConfigurationProperty
- type CfnMatchingWorkflow_OutputAttributeProperty
- type CfnMatchingWorkflow_OutputSourceProperty
- type CfnMatchingWorkflow_ProviderPropertiesProperty
- type CfnMatchingWorkflow_ResolutionTechniquesProperty
- type CfnMatchingWorkflow_RuleBasedPropertiesProperty
- type CfnMatchingWorkflow_RuleProperty
- type CfnSchemaMapping
- type CfnSchemaMappingProps
- type CfnSchemaMapping_SchemaInputAttributeProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnIdMappingWorkflow_CFN_RESOURCE_TYPE_NAME ¶ added in v2.103.0
func CfnIdMappingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdMappingWorkflow_IsCfnElement ¶ added in v2.103.0
func CfnIdMappingWorkflow_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 CfnIdMappingWorkflow_IsCfnResource ¶ added in v2.103.0
func CfnIdMappingWorkflow_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdMappingWorkflow_IsConstruct ¶ added in v2.103.0
func CfnIdMappingWorkflow_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 CfnMatchingWorkflow_CFN_RESOURCE_TYPE_NAME ¶
func CfnMatchingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
func CfnMatchingWorkflow_IsCfnElement ¶
func CfnMatchingWorkflow_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 CfnMatchingWorkflow_IsCfnResource ¶
func CfnMatchingWorkflow_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMatchingWorkflow_IsConstruct ¶
func CfnMatchingWorkflow_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 CfnSchemaMapping_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchemaMapping_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchemaMapping_IsCfnElement ¶
func CfnSchemaMapping_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 CfnSchemaMapping_IsCfnResource ¶
func CfnSchemaMapping_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSchemaMapping_IsConstruct ¶
func CfnSchemaMapping_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 NewCfnIdMappingWorkflow_Override ¶ added in v2.103.0
func NewCfnIdMappingWorkflow_Override(c CfnIdMappingWorkflow, scope constructs.Construct, id *string, props *CfnIdMappingWorkflowProps)
func NewCfnMatchingWorkflow_Override ¶
func NewCfnMatchingWorkflow_Override(c CfnMatchingWorkflow, scope constructs.Construct, id *string, props *CfnMatchingWorkflowProps)
func NewCfnSchemaMapping_Override ¶
func NewCfnSchemaMapping_Override(c CfnSchemaMapping, scope constructs.Construct, id *string, props *CfnSchemaMappingProps)
Types ¶
type CfnIdMappingWorkflow ¶ added in v2.103.0
type CfnIdMappingWorkflow interface { awscdk.CfnResource awscdk.IInspectable // The time of this IdMappingWorkflow got created. AttrCreatedAt() *string // The time of this IdMappingWorkflow got last updated at. AttrUpdatedAt() *string // The default IdMappingWorkflow arn. AttrWorkflowArn() *string // 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 // A description of the workflow. Description() *string SetDescription(val *string) // An object which defines the `idMappingType` and the `providerProperties` . IdMappingTechniques() interface{} SetIdMappingTechniques(val interface{}) // A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . InputSourceConfig() interface{} SetInputSourceConfig(val interface{}) // 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 tree node. Node() constructs.Node // A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `OutputS3Path` and `Output` . OutputSourceConfig() interface{} SetOutputSourceConfig(val interface{}) // 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 Amazon Resource Name (ARN) of the IAM role. 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 tags used to organize, track, or control access for this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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{} // The name of the workflow. WorkflowName() *string SetWorkflowName(val *string) // 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{}) }
Creates an `IdMappingWorkflow` object which stores the configuration of the data processing job to be run.
Each `IdMappingWorkflow` must have a unique workflow name. To modify an existing workflow, use the `UpdateIdMappingWorkflow` API.
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" cfnIdMappingWorkflow := awscdk.Aws_entityresolution.NewCfnIdMappingWorkflow(this, jsii.String("MyCfnIdMappingWorkflow"), &CfnIdMappingWorkflowProps{ IdMappingTechniques: &IdMappingTechniquesProperty{ IdMappingType: jsii.String("idMappingType"), ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, }, InputSourceConfig: []interface{}{ &IdMappingWorkflowInputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), }, }, OutputSourceConfig: []interface{}{ &IdMappingWorkflowOutputSourceProperty{ OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional KmsArn: jsii.String("kmsArn"), }, }, RoleArn: jsii.String("roleArn"), WorkflowName: jsii.String("workflowName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnIdMappingWorkflow ¶ added in v2.103.0
func NewCfnIdMappingWorkflow(scope constructs.Construct, id *string, props *CfnIdMappingWorkflowProps) CfnIdMappingWorkflow
type CfnIdMappingWorkflowProps ¶ added in v2.103.0
type CfnIdMappingWorkflowProps struct { // An object which defines the `idMappingType` and the `providerProperties` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques // IdMappingTechniques interface{} `field:"required" json:"idMappingTechniques" yaml:"idMappingTechniques"` // A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-inputsourceconfig // InputSourceConfig interface{} `field:"required" json:"inputSourceConfig" yaml:"inputSourceConfig"` // A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `OutputS3Path` and `Output` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-outputsourceconfig // OutputSourceConfig interface{} `field:"required" json:"outputSourceConfig" yaml:"outputSourceConfig"` // The Amazon Resource Name (ARN) of the IAM role. // // AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the workflow. // // There can't be multiple `IdMappingWorkflows` with the same name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-workflowname // WorkflowName *string `field:"required" json:"workflowName" yaml:"workflowName"` // A description of the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnIdMappingWorkflow`.
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" cfnIdMappingWorkflowProps := &CfnIdMappingWorkflowProps{ IdMappingTechniques: &IdMappingTechniquesProperty{ IdMappingType: jsii.String("idMappingType"), ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, }, InputSourceConfig: []interface{}{ &IdMappingWorkflowInputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), }, }, OutputSourceConfig: []interface{}{ &IdMappingWorkflowOutputSourceProperty{ OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional KmsArn: jsii.String("kmsArn"), }, }, RoleArn: jsii.String("roleArn"), WorkflowName: jsii.String("workflowName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnIdMappingWorkflow_IdMappingTechniquesProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_IdMappingTechniquesProperty struct { // The type of ID mapping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype // IdMappingType *string `field:"optional" json:"idMappingType" yaml:"idMappingType"` // An object which defines any additional configurations required by the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties // ProviderProperties interface{} `field:"optional" json:"providerProperties" yaml:"providerProperties"` }
An object which defines the ID mapping techniques and provider configurations.
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" idMappingTechniquesProperty := &IdMappingTechniquesProperty{ IdMappingType: jsii.String("idMappingType"), ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, }
type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty struct { // An AWS Glue table ARN for the input source table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn // InputSourceArn *string `field:"required" json:"inputSourceArn" yaml:"inputSourceArn"` // The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the `SchemaMapping` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn // SchemaArn *string `field:"required" json:"schemaArn" yaml:"schemaArn"` }
An object containing `InputSourceARN` and `SchemaName` .
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" idMappingWorkflowInputSourceProperty := &IdMappingWorkflowInputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), }
type CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty struct { // The S3 path to which AWS Entity Resolution will write the output table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path // OutputS3Path *string `field:"required" json:"outputS3Path" yaml:"outputS3Path"` // Customer AWS KMS ARN for encryption at rest. // // If not provided, system will use an AWS Entity Resolution managed KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn // KmsArn *string `field:"optional" json:"kmsArn" yaml:"kmsArn"` }
A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `OutputS3Path` and `Output` .
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" idMappingWorkflowOutputSourceProperty := &IdMappingWorkflowOutputSourceProperty{ OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional KmsArn: jsii.String("kmsArn"), }
type CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty struct { // The Amazon S3 location (bucket and prefix). // // For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path // IntermediateS3Path *string `field:"required" json:"intermediateS3Path" yaml:"intermediateS3Path"` }
The Amazon S3 location that temporarily stores your data while it processes.
Your information won't be saved permanently.
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" intermediateSourceConfigurationProperty := &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }
type CfnIdMappingWorkflow_ProviderPropertiesProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_ProviderPropertiesProperty struct { // The ARN of the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn // ProviderServiceArn *string `field:"required" json:"providerServiceArn" yaml:"providerServiceArn"` // The Amazon S3 location that temporarily stores your data while it processes. // // Your information won't be saved permanently. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration // IntermediateSourceConfiguration interface{} `field:"optional" json:"intermediateSourceConfiguration" yaml:"intermediateSourceConfiguration"` // The required configuration fields to use with the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration // ProviderConfiguration interface{} `field:"optional" json:"providerConfiguration" yaml:"providerConfiguration"` }
An object containing the `providerServiceARN` , `intermediateSourceConfiguration` , and `providerConfiguration` .
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" providerPropertiesProperty := &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }
type CfnMatchingWorkflow ¶
type CfnMatchingWorkflow interface { awscdk.CfnResource awscdk.IInspectable // The time of this MatchingWorkflow got created. AttrCreatedAt() *string // The time of this MatchingWorkflow got last updated at. AttrUpdatedAt() *string // The default MatchingWorkflow arn. AttrWorkflowArn() *string // 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 // A description of the workflow. Description() *string SetDescription(val *string) // A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . InputSourceConfig() interface{} SetInputSourceConfig(val interface{}) // 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 tree node. Node() constructs.Node // A list of `OutputSource` objects, each of which contains fields `OutputS3Path` , `ApplyNormalization` , and `Output` . OutputSourceConfig() interface{} SetOutputSourceConfig(val interface{}) // 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 // An object which defines the `resolutionType` and the `ruleBasedProperties` . ResolutionTechniques() interface{} SetResolutionTechniques(val interface{}) // The Amazon Resource Name (ARN) of the IAM role. 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 tags used to organize, track, or control access for this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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{} // The name of the workflow. WorkflowName() *string SetWorkflowName(val *string) // 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{}) }
Creates a `MatchingWorkflow` object which stores the configuration of the data processing job to be run.
It is important to note that there should not be a pre-existing `MatchingWorkflow` with the same name. To modify an existing workflow, utilize the `UpdateMatchingWorkflow` API.
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" cfnMatchingWorkflow := awscdk.Aws_entityresolution.NewCfnMatchingWorkflow(this, jsii.String("MyCfnMatchingWorkflow"), &CfnMatchingWorkflowProps{ InputSourceConfig: []interface{}{ &InputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), }, }, OutputSourceConfig: []interface{}{ &OutputSourceProperty{ Output: []interface{}{ &OutputAttributeProperty{ Name: jsii.String("name"), // the properties below are optional Hashed: jsii.Boolean(false), }, }, OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), KmsArn: jsii.String("kmsArn"), }, }, ResolutionTechniques: &ResolutionTechniquesProperty{ ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, ResolutionType: jsii.String("resolutionType"), RuleBasedProperties: &RuleBasedPropertiesProperty{ AttributeMatchingModel: jsii.String("attributeMatchingModel"), Rules: []interface{}{ &RuleProperty{ MatchingKeys: []*string{ jsii.String("matchingKeys"), }, RuleName: jsii.String("ruleName"), }, }, }, }, RoleArn: jsii.String("roleArn"), WorkflowName: jsii.String("workflowName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMatchingWorkflow ¶
func NewCfnMatchingWorkflow(scope constructs.Construct, id *string, props *CfnMatchingWorkflowProps) CfnMatchingWorkflow
type CfnMatchingWorkflowProps ¶
type CfnMatchingWorkflowProps struct { // A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-inputsourceconfig // InputSourceConfig interface{} `field:"required" json:"inputSourceConfig" yaml:"inputSourceConfig"` // A list of `OutputSource` objects, each of which contains fields `OutputS3Path` , `ApplyNormalization` , and `Output` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-outputsourceconfig // OutputSourceConfig interface{} `field:"required" json:"outputSourceConfig" yaml:"outputSourceConfig"` // An object which defines the `resolutionType` and the `ruleBasedProperties` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-resolutiontechniques // ResolutionTechniques interface{} `field:"required" json:"resolutionTechniques" yaml:"resolutionTechniques"` // The Amazon Resource Name (ARN) of the IAM role. // // AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the workflow. // // There can't be multiple `MatchingWorkflows` with the same name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-workflowname // WorkflowName *string `field:"required" json:"workflowName" yaml:"workflowName"` // A description of the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMatchingWorkflow`.
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" cfnMatchingWorkflowProps := &CfnMatchingWorkflowProps{ InputSourceConfig: []interface{}{ &InputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), }, }, OutputSourceConfig: []interface{}{ &OutputSourceProperty{ Output: []interface{}{ &OutputAttributeProperty{ Name: jsii.String("name"), // the properties below are optional Hashed: jsii.Boolean(false), }, }, OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), KmsArn: jsii.String("kmsArn"), }, }, ResolutionTechniques: &ResolutionTechniquesProperty{ ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, ResolutionType: jsii.String("resolutionType"), RuleBasedProperties: &RuleBasedPropertiesProperty{ AttributeMatchingModel: jsii.String("attributeMatchingModel"), Rules: []interface{}{ &RuleProperty{ MatchingKeys: []*string{ jsii.String("matchingKeys"), }, RuleName: jsii.String("ruleName"), }, }, }, }, RoleArn: jsii.String("roleArn"), WorkflowName: jsii.String("workflowName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMatchingWorkflow_InputSourceProperty ¶
type CfnMatchingWorkflow_InputSourceProperty struct { // An object containing `InputSourceARN` , `SchemaName` , and `ApplyNormalization` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-inputsourcearn // InputSourceArn *string `field:"required" json:"inputSourceArn" yaml:"inputSourceArn"` // The name of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-schemaarn // SchemaArn *string `field:"required" json:"schemaArn" yaml:"schemaArn"` // Normalizes the attributes defined in the schema in the input data. // // For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-applynormalization // ApplyNormalization interface{} `field:"optional" json:"applyNormalization" yaml:"applyNormalization"` }
An object containing `InputSourceARN` , `SchemaName` , and `ApplyNormalization` .
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" inputSourceProperty := &InputSourceProperty{ InputSourceArn: jsii.String("inputSourceArn"), SchemaArn: jsii.String("schemaArn"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), }
type CfnMatchingWorkflow_IntermediateSourceConfigurationProperty ¶ added in v2.103.0
type CfnMatchingWorkflow_IntermediateSourceConfigurationProperty struct { // The Amazon S3 location (bucket and prefix). // // For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-matchingworkflow-intermediatesourceconfiguration-intermediates3path // IntermediateS3Path *string `field:"required" json:"intermediateS3Path" yaml:"intermediateS3Path"` }
The Amazon S3 location that temporarily stores your data while it processes.
Your information won't be saved permanently.
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" intermediateSourceConfigurationProperty := &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }
type CfnMatchingWorkflow_OutputAttributeProperty ¶
type CfnMatchingWorkflow_OutputAttributeProperty struct { // A name of a column to be written to the output. // // This must be an `InputField` name in the schema mapping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-name // Name *string `field:"required" json:"name" yaml:"name"` // Enables the ability to hash the column values in the output. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-hashed // Hashed interface{} `field:"optional" json:"hashed" yaml:"hashed"` }
A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` .
Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
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" outputAttributeProperty := &OutputAttributeProperty{ Name: jsii.String("name"), // the properties below are optional Hashed: jsii.Boolean(false), }
type CfnMatchingWorkflow_OutputSourceProperty ¶
type CfnMatchingWorkflow_OutputSourceProperty struct { // A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . // // Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-output // Output interface{} `field:"required" json:"output" yaml:"output"` // The S3 path to which AWS Entity Resolution will write the output table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-outputs3path // OutputS3Path *string `field:"required" json:"outputS3Path" yaml:"outputS3Path"` // Normalizes the attributes defined in the schema in the input data. // // For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-applynormalization // ApplyNormalization interface{} `field:"optional" json:"applyNormalization" yaml:"applyNormalization"` // Customer KMS ARN for encryption at rest. // // If not provided, system will use an AWS Entity Resolution managed KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-kmsarn // KmsArn *string `field:"optional" json:"kmsArn" yaml:"kmsArn"` }
A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` .
Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
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" outputSourceProperty := &OutputSourceProperty{ Output: []interface{}{ &OutputAttributeProperty{ Name: jsii.String("name"), // the properties below are optional Hashed: jsii.Boolean(false), }, }, OutputS3Path: jsii.String("outputS3Path"), // the properties below are optional ApplyNormalization: jsii.Boolean(false), KmsArn: jsii.String("kmsArn"), }
type CfnMatchingWorkflow_ProviderPropertiesProperty ¶ added in v2.103.0
type CfnMatchingWorkflow_ProviderPropertiesProperty struct { // The ARN of the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-providerservicearn // ProviderServiceArn *string `field:"required" json:"providerServiceArn" yaml:"providerServiceArn"` // The Amazon S3 location that temporarily stores your data while it processes. // // Your information won't be saved permanently. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-intermediatesourceconfiguration // IntermediateSourceConfiguration interface{} `field:"optional" json:"intermediateSourceConfiguration" yaml:"intermediateSourceConfiguration"` // The required configuration fields to use with the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-providerconfiguration // ProviderConfiguration interface{} `field:"optional" json:"providerConfiguration" yaml:"providerConfiguration"` }
An object containing the `providerServiceARN` , `intermediateSourceConfiguration` , and `providerConfiguration` .
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" providerPropertiesProperty := &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }
type CfnMatchingWorkflow_ResolutionTechniquesProperty ¶
type CfnMatchingWorkflow_ResolutionTechniquesProperty struct { // The properties of the provider service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-providerproperties // ProviderProperties interface{} `field:"optional" json:"providerProperties" yaml:"providerProperties"` // The type of matching. // // There are two types of matching: `RULE_MATCHING` and `ML_MATCHING` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-resolutiontype // ResolutionType *string `field:"optional" json:"resolutionType" yaml:"resolutionType"` // An object which defines the list of matching rules to run and has a field `Rules` , which is a list of rule objects. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-rulebasedproperties // RuleBasedProperties interface{} `field:"optional" json:"ruleBasedProperties" yaml:"ruleBasedProperties"` }
An object which defines the `resolutionType` and the `ruleBasedProperties` .
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" resolutionTechniquesProperty := &ResolutionTechniquesProperty{ ProviderProperties: &ProviderPropertiesProperty{ ProviderServiceArn: jsii.String("providerServiceArn"), // the properties below are optional IntermediateSourceConfiguration: &IntermediateSourceConfigurationProperty{ IntermediateS3Path: jsii.String("intermediateS3Path"), }, ProviderConfiguration: map[string]*string{ "providerConfigurationKey": jsii.String("providerConfiguration"), }, }, ResolutionType: jsii.String("resolutionType"), RuleBasedProperties: &RuleBasedPropertiesProperty{ AttributeMatchingModel: jsii.String("attributeMatchingModel"), Rules: []interface{}{ &RuleProperty{ MatchingKeys: []*string{ jsii.String("matchingKeys"), }, RuleName: jsii.String("ruleName"), }, }, }, }
type CfnMatchingWorkflow_RuleBasedPropertiesProperty ¶
type CfnMatchingWorkflow_RuleBasedPropertiesProperty struct { // The comparison type. // // You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the AttributeMatchingModel. When choosing `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A and the value of `BusinessEmail` field of Profile B matches, the two profiles are matched on the `Email` type. When choosing `ONE_TO_ONE` ,the system can only match if the sub-types are exact matches. For example, only when the value of the `Email` field of Profile A and the value of the `Email` field of Profile B matches, the two profiles are matched on the `Email` type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-attributematchingmodel // AttributeMatchingModel *string `field:"required" json:"attributeMatchingModel" yaml:"attributeMatchingModel"` // A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-rules // Rules interface{} `field:"required" json:"rules" yaml:"rules"` }
An object which defines the list of matching rules to run and has a field `Rules` , which is a list of rule objects.
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" ruleBasedPropertiesProperty := &RuleBasedPropertiesProperty{ AttributeMatchingModel: jsii.String("attributeMatchingModel"), Rules: []interface{}{ &RuleProperty{ MatchingKeys: []*string{ jsii.String("matchingKeys"), }, RuleName: jsii.String("ruleName"), }, }, }
type CfnMatchingWorkflow_RuleProperty ¶
type CfnMatchingWorkflow_RuleProperty struct { // A list of `MatchingKeys` . // // The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rule.html#cfn-entityresolution-matchingworkflow-rule-matchingkeys // MatchingKeys *[]*string `field:"required" json:"matchingKeys" yaml:"matchingKeys"` // A name for the matching rule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rule.html#cfn-entityresolution-matchingworkflow-rule-rulename // RuleName *string `field:"required" json:"ruleName" yaml:"ruleName"` }
An object containing `RuleName` , and `MatchingKeys` .
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" ruleProperty := &RuleProperty{ MatchingKeys: []*string{ jsii.String("matchingKeys"), }, RuleName: jsii.String("ruleName"), }
type CfnSchemaMapping ¶
type CfnSchemaMapping interface { awscdk.CfnResource awscdk.IInspectable // The time of this SchemaMapping got created. AttrCreatedAt() *string // The boolean value that indicates whether or not a SchemaMapping has MatchingWorkflows that are associated with. AttrHasWorkflows() awscdk.IResolvable // The SchemaMapping arn associated with the Schema. AttrSchemaArn() *string // The time of this SchemaMapping got last updated at. AttrUpdatedAt() *string // 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 // A description of the schema. 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 // A list of `MappedInputFields` . MappedInputFields() interface{} SetMappedInputFields(val interface{}) // 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 name of the schema. SchemaName() *string SetSchemaName(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 tags used to organize, track, or control access for this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // 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{}) }
Creates a schema mapping, which defines the schema of the input customer records table.
The `SchemaMapping` also provides AWS Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
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" cfnSchemaMapping := awscdk.Aws_entityresolution.NewCfnSchemaMapping(this, jsii.String("MyCfnSchemaMapping"), &CfnSchemaMappingProps{ MappedInputFields: []interface{}{ &SchemaInputAttributeProperty{ FieldName: jsii.String("fieldName"), Type: jsii.String("type"), // the properties below are optional GroupName: jsii.String("groupName"), MatchKey: jsii.String("matchKey"), SubType: jsii.String("subType"), }, }, SchemaName: jsii.String("schemaName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnSchemaMapping ¶
func NewCfnSchemaMapping(scope constructs.Construct, id *string, props *CfnSchemaMappingProps) CfnSchemaMapping
type CfnSchemaMappingProps ¶
type CfnSchemaMappingProps struct { // A list of `MappedInputFields` . // // Each `MappedInputField` corresponds to a column the source data table, and contains column name plus additional information that AWS Entity Resolution uses for matching. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-mappedinputfields // MappedInputFields interface{} `field:"required" json:"mappedInputFields" yaml:"mappedInputFields"` // The name of the schema. // // There can't be multiple `SchemaMappings` with the same name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-schemaname // SchemaName *string `field:"required" json:"schemaName" yaml:"schemaName"` // A description of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags used to organize, track, or control access for this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-schemamapping.html#cfn-entityresolution-schemamapping-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSchemaMapping`.
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" cfnSchemaMappingProps := &CfnSchemaMappingProps{ MappedInputFields: []interface{}{ &SchemaInputAttributeProperty{ FieldName: jsii.String("fieldName"), Type: jsii.String("type"), // the properties below are optional GroupName: jsii.String("groupName"), MatchKey: jsii.String("matchKey"), SubType: jsii.String("subType"), }, }, SchemaName: jsii.String("schemaName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnSchemaMapping_SchemaInputAttributeProperty ¶
type CfnSchemaMapping_SchemaInputAttributeProperty struct { // A string containing the field name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-fieldname // FieldName *string `field:"required" json:"fieldName" yaml:"fieldName"` // The type of the attribute, selected from a list of values. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-type // Type *string `field:"required" json:"type" yaml:"type"` // Instruct AWS Entity Resolution to combine several columns into a unified column with the identical attribute type. // // For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common `GroupName` will prompt AWS Entity Resolution to concatenate them into a single value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-groupname // GroupName *string `field:"optional" json:"groupName" yaml:"groupName"` // A key that allows grouping of multiple input attributes into a unified matching group. // // For example, let's consider a scenario where the source table contains various addresses, such as `business_address` and `shipping_address` . By assigning the `MatchKey` *Address* to both attributes, AWS Entity Resolution will match records across these fields to create a consolidated matching group. If no `MatchKey` is specified for a column, it won't be utilized for matching purposes but will still be included in the output table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-matchkey // MatchKey *string `field:"optional" json:"matchKey" yaml:"matchKey"` // The subtype of the attribute, selected from a list of values. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-subtype // SubType *string `field:"optional" json:"subType" yaml:"subType"` }
An object containing `FieldName` , `Type` , `GroupName` , and `MatchKey` .
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" schemaInputAttributeProperty := &SchemaInputAttributeProperty{ FieldName: jsii.String("fieldName"), Type: jsii.String("type"), // the properties below are optional GroupName: jsii.String("groupName"), MatchKey: jsii.String("matchKey"), SubType: jsii.String("subType"), }
Source Files ¶
- CfnIdMappingWorkflow.go
- CfnIdMappingWorkflowProps.go
- CfnIdMappingWorkflow_IdMappingTechniquesProperty.go
- CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty.go
- CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty.go
- CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty.go
- CfnIdMappingWorkflow_ProviderPropertiesProperty.go
- CfnIdMappingWorkflow__checks.go
- CfnMatchingWorkflow.go
- CfnMatchingWorkflowProps.go
- CfnMatchingWorkflow_InputSourceProperty.go
- CfnMatchingWorkflow_IntermediateSourceConfigurationProperty.go
- CfnMatchingWorkflow_OutputAttributeProperty.go
- CfnMatchingWorkflow_OutputSourceProperty.go
- CfnMatchingWorkflow_ProviderPropertiesProperty.go
- CfnMatchingWorkflow_ResolutionTechniquesProperty.go
- CfnMatchingWorkflow_RuleBasedPropertiesProperty.go
- CfnMatchingWorkflow_RuleProperty.go
- CfnMatchingWorkflow__checks.go
- CfnSchemaMapping.go
- CfnSchemaMappingProps.go
- CfnSchemaMapping_SchemaInputAttributeProperty.go
- CfnSchemaMapping__checks.go
- main.go