Documentation
¶
Index ¶
- func CfnIdMappingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdMappingWorkflow_FromWorkflowName(scope constructs.Construct, id *string, workflowName *string) interfacesawsentityresolution.IIdMappingWorkflowRef
- func CfnIdMappingWorkflow_IsCfnElement(x interface{}) *bool
- func CfnIdMappingWorkflow_IsCfnResource(x interface{}) *bool
- func CfnIdMappingWorkflow_IsConstruct(x interface{}) *bool
- func CfnIdNamespace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdNamespace_FromIdNamespaceArn(scope constructs.Construct, id *string, arn *string) interfacesawsentityresolution.IIdNamespaceRef
- func CfnIdNamespace_FromIdNamespaceName(scope constructs.Construct, id *string, idNamespaceName *string) interfacesawsentityresolution.IIdNamespaceRef
- func CfnIdNamespace_IsCfnElement(x interface{}) *bool
- func CfnIdNamespace_IsCfnResource(x interface{}) *bool
- func CfnIdNamespace_IsConstruct(x interface{}) *bool
- func CfnMatchingWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMatchingWorkflow_FromWorkflowName(scope constructs.Construct, id *string, workflowName *string) interfacesawsentityresolution.IMatchingWorkflowRef
- func CfnMatchingWorkflow_IsCfnElement(x interface{}) *bool
- func CfnMatchingWorkflow_IsCfnResource(x interface{}) *bool
- func CfnMatchingWorkflow_IsConstruct(x interface{}) *bool
- func CfnPolicyStatement_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPolicyStatement_IsCfnElement(x interface{}) *bool
- func CfnPolicyStatement_IsCfnResource(x interface{}) *bool
- func CfnPolicyStatement_IsConstruct(x interface{}) *bool
- func CfnSchemaMapping_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchemaMapping_FromSchemaName(scope constructs.Construct, id *string, schemaName *string) interfacesawsentityresolution.ISchemaMappingRef
- 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 NewCfnIdNamespace_Override(c CfnIdNamespace, scope constructs.Construct, id *string, ...)
- func NewCfnMatchingWorkflow_Override(c CfnMatchingWorkflow, scope constructs.Construct, id *string, ...)
- func NewCfnPolicyStatement_Override(c CfnPolicyStatement, scope constructs.Construct, id *string, ...)
- func NewCfnSchemaMapping_Override(c CfnSchemaMapping, scope constructs.Construct, id *string, ...)
- type CfnIdMappingWorkflow
- type CfnIdMappingWorkflowProps
- type CfnIdMappingWorkflow_IdMappingIncrementalRunConfigProperty
- type CfnIdMappingWorkflow_IdMappingRuleBasedPropertiesProperty
- type CfnIdMappingWorkflow_IdMappingTechniquesProperty
- type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty
- type CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty
- type CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty
- type CfnIdMappingWorkflow_ProviderPropertiesProperty
- type CfnIdMappingWorkflow_RuleProperty
- type CfnIdNamespace
- type CfnIdNamespaceProps
- type CfnIdNamespace_IdNamespaceIdMappingWorkflowPropertiesProperty
- type CfnIdNamespace_IdNamespaceInputSourceProperty
- type CfnIdNamespace_NamespaceProviderPropertiesProperty
- type CfnIdNamespace_NamespaceRuleBasedPropertiesProperty
- type CfnIdNamespace_RuleProperty
- type CfnMatchingWorkflow
- type CfnMatchingWorkflowProps
- type CfnMatchingWorkflow_IncrementalRunConfigProperty
- type CfnMatchingWorkflow_InputSourceProperty
- type CfnMatchingWorkflow_IntermediateSourceConfigurationProperty
- type CfnMatchingWorkflow_OutputAttributeProperty
- type CfnMatchingWorkflow_OutputSourceProperty
- type CfnMatchingWorkflow_ProviderPropertiesProperty
- type CfnMatchingWorkflow_ResolutionTechniquesProperty
- type CfnMatchingWorkflow_RuleBasedPropertiesProperty
- type CfnMatchingWorkflow_RuleConditionPropertiesProperty
- type CfnMatchingWorkflow_RuleConditionProperty
- type CfnMatchingWorkflow_RuleProperty
- type CfnPolicyStatement
- type CfnPolicyStatementProps
- 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_FromWorkflowName ¶ added in v2.218.0
func CfnIdMappingWorkflow_FromWorkflowName(scope constructs.Construct, id *string, workflowName *string) interfacesawsentityresolution.IIdMappingWorkflowRef
Creates a new IIdMappingWorkflowRef from a workflowName.
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 CfnIdNamespace_CFN_RESOURCE_TYPE_NAME ¶ added in v2.138.0
func CfnIdNamespace_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdNamespace_FromIdNamespaceArn ¶ added in v2.218.0
func CfnIdNamespace_FromIdNamespaceArn(scope constructs.Construct, id *string, arn *string) interfacesawsentityresolution.IIdNamespaceRef
Creates a new IIdNamespaceRef from an ARN.
func CfnIdNamespace_FromIdNamespaceName ¶ added in v2.218.0
func CfnIdNamespace_FromIdNamespaceName(scope constructs.Construct, id *string, idNamespaceName *string) interfacesawsentityresolution.IIdNamespaceRef
Creates a new IIdNamespaceRef from a idNamespaceName.
func CfnIdNamespace_IsCfnElement ¶ added in v2.138.0
func CfnIdNamespace_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 CfnIdNamespace_IsCfnResource ¶ added in v2.138.0
func CfnIdNamespace_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdNamespace_IsConstruct ¶ added in v2.138.0
func CfnIdNamespace_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_FromWorkflowName ¶ added in v2.218.0
func CfnMatchingWorkflow_FromWorkflowName(scope constructs.Construct, id *string, workflowName *string) interfacesawsentityresolution.IMatchingWorkflowRef
Creates a new IMatchingWorkflowRef from a workflowName.
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 CfnPolicyStatement_CFN_RESOURCE_TYPE_NAME ¶ added in v2.138.0
func CfnPolicyStatement_CFN_RESOURCE_TYPE_NAME() *string
func CfnPolicyStatement_IsCfnElement ¶ added in v2.138.0
func CfnPolicyStatement_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 CfnPolicyStatement_IsCfnResource ¶ added in v2.138.0
func CfnPolicyStatement_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPolicyStatement_IsConstruct ¶ added in v2.138.0
func CfnPolicyStatement_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_FromSchemaName ¶ added in v2.218.0
func CfnSchemaMapping_FromSchemaName(scope constructs.Construct, id *string, schemaName *string) interfacesawsentityresolution.ISchemaMappingRef
Creates a new ISchemaMappingRef from a schemaName.
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)
Create a new `AWS::EntityResolution::IdMappingWorkflow`.
func NewCfnIdNamespace_Override ¶ added in v2.138.0
func NewCfnIdNamespace_Override(c CfnIdNamespace, scope constructs.Construct, id *string, props *CfnIdNamespaceProps)
Create a new `AWS::EntityResolution::IdNamespace`.
func NewCfnMatchingWorkflow_Override ¶
func NewCfnMatchingWorkflow_Override(c CfnMatchingWorkflow, scope constructs.Construct, id *string, props *CfnMatchingWorkflowProps)
Create a new `AWS::EntityResolution::MatchingWorkflow`.
func NewCfnPolicyStatement_Override ¶ added in v2.138.0
func NewCfnPolicyStatement_Override(c CfnPolicyStatement, scope constructs.Construct, id *string, props *CfnPolicyStatementProps)
Create a new `AWS::EntityResolution::PolicyStatement`.
func NewCfnSchemaMapping_Override ¶
func NewCfnSchemaMapping_Override(c CfnSchemaMapping, scope constructs.Construct, id *string, props *CfnSchemaMappingProps)
Create a new `AWS::EntityResolution::SchemaMapping`.
Types ¶
type CfnIdMappingWorkflow ¶ added in v2.103.0
type CfnIdMappingWorkflow interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsentityresolution.IIdMappingWorkflowRef
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A description of the workflow.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
IdMappingIncrementalRunConfig() interface{}
SetIdMappingIncrementalRunConfig(val interface{})
// An object which defines the ID mapping technique and any additional configurations.
IdMappingTechniques() interface{}
SetIdMappingTechniques(val interface{})
// A reference to a IdMappingWorkflow resource.
IdMappingWorkflowRef() *interfacesawsentityresolution.IdMappingWorkflowReference
// 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 `KMSArn` .
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.
> Incremental processing is not supported for ID mapping workflows.
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"),
NormalizationVersion: jsii.String("normalizationVersion"),
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"),
},
},
RuleBasedProperties: &IdMappingRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModel: jsii.String("recordMatchingModel"),
// the properties below are optional
RuleDefinitionType: jsii.String("ruleDefinitionType"),
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
},
InputSourceConfig: []interface{}{
&IdMappingWorkflowInputSourceProperty{
InputSourceArn: jsii.String("inputSourceArn"),
// the properties below are optional
SchemaArn: jsii.String("schemaArn"),
Type: jsii.String("type"),
},
},
RoleArn: jsii.String("roleArn"),
WorkflowName: jsii.String("workflowName"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingIncrementalRunConfig: &IdMappingIncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
},
OutputSourceConfig: []interface{}{
&IdMappingWorkflowOutputSourceProperty{
OutputS3Path: jsii.String("outputS3Path"),
// the properties below are optional
KmsArn: jsii.String("kmsArn"),
},
},
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
Create a new `AWS::EntityResolution::IdMappingWorkflow`.
type CfnIdMappingWorkflowProps ¶ added in v2.103.0
type CfnIdMappingWorkflowProps struct {
// An object which defines the ID mapping technique and any additional configurations.
// 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"`
// 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"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig
//
IdMappingIncrementalRunConfig interface{} `field:"optional" json:"idMappingIncrementalRunConfig" yaml:"idMappingIncrementalRunConfig"`
// A list of `IdMappingWorkflowOutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html#cfn-entityresolution-idmappingworkflow-outputsourceconfig
//
OutputSourceConfig interface{} `field:"optional" json:"outputSourceConfig" yaml:"outputSourceConfig"`
// 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"),
NormalizationVersion: jsii.String("normalizationVersion"),
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"),
},
},
RuleBasedProperties: &IdMappingRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModel: jsii.String("recordMatchingModel"),
// the properties below are optional
RuleDefinitionType: jsii.String("ruleDefinitionType"),
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
},
InputSourceConfig: []interface{}{
&IdMappingWorkflowInputSourceProperty{
InputSourceArn: jsii.String("inputSourceArn"),
// the properties below are optional
SchemaArn: jsii.String("schemaArn"),
Type: jsii.String("type"),
},
},
RoleArn: jsii.String("roleArn"),
WorkflowName: jsii.String("workflowName"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingIncrementalRunConfig: &IdMappingIncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
},
OutputSourceConfig: []interface{}{
&IdMappingWorkflowOutputSourceProperty{
OutputS3Path: jsii.String("outputS3Path"),
// the properties below are optional
KmsArn: jsii.String("kmsArn"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIdMappingWorkflow_IdMappingIncrementalRunConfigProperty ¶ added in v2.214.0
type CfnIdMappingWorkflow_IdMappingIncrementalRunConfigProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype
//
IncrementalRunType *string `field:"required" json:"incrementalRunType" yaml:"incrementalRunType"`
}
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"
idMappingIncrementalRunConfigProperty := &IdMappingIncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
}
type CfnIdMappingWorkflow_IdMappingRuleBasedPropertiesProperty ¶ added in v2.154.0
type CfnIdMappingWorkflow_IdMappingRuleBasedPropertiesProperty struct {
// The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
//
// If you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.
//
// If you choose `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 matches the value of the `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel
//
AttributeMatchingModel *string `field:"required" json:"attributeMatchingModel" yaml:"attributeMatchingModel"`
// The type of matching record that is allowed to be used in an ID mapping workflow.
//
// If the value is set to `ONE_SOURCE_TO_ONE_TARGET` , only one record in the source can be matched to the same record in the target.
//
// If the value is set to `MANY_SOURCE_TO_ONE_TARGET` , multiple records in the source can be matched to one record in the target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel
//
RecordMatchingModel *string `field:"required" json:"recordMatchingModel" yaml:"recordMatchingModel"`
// The set of rules you can use in an ID mapping workflow.
//
// The limitations specified for the source or target to define the match rules must be compatible.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype
//
RuleDefinitionType *string `field:"optional" json:"ruleDefinitionType" yaml:"ruleDefinitionType"`
// The rules that can be used for ID mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules
//
Rules interface{} `field:"optional" json:"rules" yaml:"rules"`
}
An object that defines the list of matching rules to run in an ID mapping workflow.
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"
idMappingRuleBasedPropertiesProperty := &IdMappingRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModel: jsii.String("recordMatchingModel"),
// the properties below are optional
RuleDefinitionType: jsii.String("ruleDefinitionType"),
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
}
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"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion
//
NormalizationVersion *string `field:"optional" json:"normalizationVersion" yaml:"normalizationVersion"`
// 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 any additional configurations required by rule-based matching.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties
//
RuleBasedProperties interface{} `field:"optional" json:"ruleBasedProperties" yaml:"ruleBasedProperties"`
}
An object which defines the ID mapping technique and any additional 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"),
NormalizationVersion: jsii.String("normalizationVersion"),
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"),
},
},
RuleBasedProperties: &IdMappingRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModel: jsii.String("recordMatchingModel"),
// the properties below are optional
RuleDefinitionType: jsii.String("ruleDefinitionType"),
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
}
type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty ¶ added in v2.103.0
type CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty struct {
// An AWS Glue table Amazon Resource Name (ARN) or a matching workflow 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:"optional" json:"schemaArn" yaml:"schemaArn"`
// The type of ID namespace. There are two types: `SOURCE` and `TARGET` .
//
// The `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.
//
// The `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
An object containing `inputSourceARN` , `schemaName` , and `type` .
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"),
// the properties below are optional
SchemaArn: jsii.String("schemaArn"),
Type: jsii.String("type"),
}
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 `KMSArn` .
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 CfnIdMappingWorkflow_RuleProperty ¶ added in v2.154.0
type CfnIdMappingWorkflow_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-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-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-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-rule-rulename
//
RuleName *string `field:"required" json:"ruleName" yaml:"ruleName"`
}
An object containing the `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 CfnIdNamespace ¶ added in v2.138.0
type CfnIdNamespace interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsentityresolution.IIdNamespaceRef
awscdk.ITaggableV2
// The date and time when the IdNamespace was created.
AttrCreatedAt() *string
// The arn associated with the IdNamespace.
AttrIdNamespaceArn() *string
// The date and time when the IdNamespace was updated.
AttrUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the ID namespace.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// Determines the properties of `IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target` .
IdMappingWorkflowProperties() interface{}
SetIdMappingWorkflowProperties(val interface{})
// The name of the ID namespace.
IdNamespaceName() *string
SetIdNamespaceName(val *string)
// A reference to a IdNamespace resource.
IdNamespaceRef() *interfacesawsentityresolution.IdNamespaceReference
// 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
// 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)
// The type of ID namespace.
//
// There are two types: `SOURCE` and `TARGET` .
Type() *string
SetType(val *string)
// 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 an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.
Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace 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"
cfnIdNamespace := awscdk.Aws_entityresolution.NewCfnIdNamespace(this, jsii.String("MyCfnIdNamespace"), &CfnIdNamespaceProps{
IdNamespaceName: jsii.String("idNamespaceName"),
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingWorkflowProperties: []interface{}{
&IdNamespaceIdMappingWorkflowPropertiesProperty{
IdMappingType: jsii.String("idMappingType"),
// the properties below are optional
ProviderProperties: &NamespaceProviderPropertiesProperty{
ProviderServiceArn: jsii.String("providerServiceArn"),
// the properties below are optional
ProviderConfiguration: map[string]*string{
"providerConfigurationKey": jsii.String("providerConfiguration"),
},
},
RuleBasedProperties: &NamespaceRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModels: []*string{
jsii.String("recordMatchingModels"),
},
RuleDefinitionTypes: []*string{
jsii.String("ruleDefinitionTypes"),
},
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
},
},
InputSourceConfig: []interface{}{
&IdNamespaceInputSourceProperty{
InputSourceArn: jsii.String("inputSourceArn"),
// the properties below are optional
SchemaName: jsii.String("schemaName"),
},
},
RoleArn: jsii.String("roleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnIdNamespace ¶ added in v2.138.0
func NewCfnIdNamespace(scope constructs.Construct, id *string, props *CfnIdNamespaceProps) CfnIdNamespace
Create a new `AWS::EntityResolution::IdNamespace`.
type CfnIdNamespaceProps ¶ added in v2.138.0
type CfnIdNamespaceProps struct {
// The name of the ID namespace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idnamespacename
//
IdNamespaceName *string `field:"required" json:"idNamespaceName" yaml:"idNamespaceName"`
// The type of ID namespace. There are two types: `SOURCE` and `TARGET` .
//
// The `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.
//
// The `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The description of the ID namespace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Determines the properties of `IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idmappingworkflowproperties
//
IdMappingWorkflowProperties interface{} `field:"optional" json:"idMappingWorkflowProperties" yaml:"idMappingWorkflowProperties"`
// A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-inputsourceconfig
//
InputSourceConfig interface{} `field:"optional" json:"inputSourceConfig" yaml:"inputSourceConfig"`
// The Amazon Resource Name (ARN) of the IAM role.
//
// AWS Entity Resolution assumes this role to access the resources defined in this `IdNamespace` on your behalf as part of the workflow run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-rolearn
//
RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIdNamespace`.
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"
cfnIdNamespaceProps := &CfnIdNamespaceProps{
IdNamespaceName: jsii.String("idNamespaceName"),
Type: jsii.String("type"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingWorkflowProperties: []interface{}{
&IdNamespaceIdMappingWorkflowPropertiesProperty{
IdMappingType: jsii.String("idMappingType"),
// the properties below are optional
ProviderProperties: &NamespaceProviderPropertiesProperty{
ProviderServiceArn: jsii.String("providerServiceArn"),
// the properties below are optional
ProviderConfiguration: map[string]*string{
"providerConfigurationKey": jsii.String("providerConfiguration"),
},
},
RuleBasedProperties: &NamespaceRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModels: []*string{
jsii.String("recordMatchingModels"),
},
RuleDefinitionTypes: []*string{
jsii.String("ruleDefinitionTypes"),
},
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
},
},
InputSourceConfig: []interface{}{
&IdNamespaceInputSourceProperty{
InputSourceArn: jsii.String("inputSourceArn"),
// the properties below are optional
SchemaName: jsii.String("schemaName"),
},
},
RoleArn: jsii.String("roleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIdNamespace_IdNamespaceIdMappingWorkflowPropertiesProperty ¶ added in v2.138.0
type CfnIdNamespace_IdNamespaceIdMappingWorkflowPropertiesProperty struct {
// The type of ID mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-idmappingtype
//
IdMappingType *string `field:"required" 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-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-providerproperties
//
ProviderProperties interface{} `field:"optional" json:"providerProperties" yaml:"providerProperties"`
// An object which defines any additional configurations required by rule-based matching.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-rulebasedproperties
//
RuleBasedProperties interface{} `field:"optional" json:"ruleBasedProperties" yaml:"ruleBasedProperties"`
}
An object containing `idMappingType` , `providerProperties` , and `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"
idNamespaceIdMappingWorkflowPropertiesProperty := &IdNamespaceIdMappingWorkflowPropertiesProperty{
IdMappingType: jsii.String("idMappingType"),
// the properties below are optional
ProviderProperties: &NamespaceProviderPropertiesProperty{
ProviderServiceArn: jsii.String("providerServiceArn"),
// the properties below are optional
ProviderConfiguration: map[string]*string{
"providerConfigurationKey": jsii.String("providerConfiguration"),
},
},
RuleBasedProperties: &NamespaceRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModels: []*string{
jsii.String("recordMatchingModels"),
},
RuleDefinitionTypes: []*string{
jsii.String("ruleDefinitionTypes"),
},
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
},
}
type CfnIdNamespace_IdNamespaceInputSourceProperty ¶ added in v2.138.0
type CfnIdNamespace_IdNamespaceInputSourceProperty struct {
// An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-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-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-schemaname
//
SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"`
}
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"
idNamespaceInputSourceProperty := &IdNamespaceInputSourceProperty{
InputSourceArn: jsii.String("inputSourceArn"),
// the properties below are optional
SchemaName: jsii.String("schemaName"),
}
type CfnIdNamespace_NamespaceProviderPropertiesProperty ¶ added in v2.138.0
type CfnIdNamespace_NamespaceProviderPropertiesProperty struct {
// The Amazon Resource Name (ARN) of the provider service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerservicearn
//
ProviderServiceArn *string `field:"required" json:"providerServiceArn" yaml:"providerServiceArn"`
// An object which defines any additional configurations required by the provider service.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerconfiguration
//
ProviderConfiguration interface{} `field:"optional" json:"providerConfiguration" yaml:"providerConfiguration"`
}
An object containing `providerConfiguration` and `providerServiceArn` .
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"
namespaceProviderPropertiesProperty := &NamespaceProviderPropertiesProperty{
ProviderServiceArn: jsii.String("providerServiceArn"),
// the properties below are optional
ProviderConfiguration: map[string]*string{
"providerConfigurationKey": jsii.String("providerConfiguration"),
},
}
type CfnIdNamespace_NamespaceRuleBasedPropertiesProperty ¶ added in v2.154.0
type CfnIdNamespace_NamespaceRuleBasedPropertiesProperty struct {
// The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
//
// If you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.
//
// If you choose `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 matches the value of `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-attributematchingmodel
//
AttributeMatchingModel *string `field:"optional" json:"attributeMatchingModel" yaml:"attributeMatchingModel"`
// The type of matching record that is allowed to be used in an ID mapping workflow.
//
// If the value is set to `ONE_SOURCE_TO_ONE_TARGET` , only one record in the source is matched to one record in the target.
//
// If the value is set to `MANY_SOURCE_TO_ONE_TARGET` , all matching records in the source are matched to one record in the target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-recordmatchingmodels
//
RecordMatchingModels *[]*string `field:"optional" json:"recordMatchingModels" yaml:"recordMatchingModels"`
// The sets of rules you can use in an ID mapping workflow.
//
// The limitations specified for the source and target must be compatible.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-ruledefinitiontypes
//
RuleDefinitionTypes *[]*string `field:"optional" json:"ruleDefinitionTypes" yaml:"ruleDefinitionTypes"`
// The rules for the ID namespace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-rules
//
Rules interface{} `field:"optional" json:"rules" yaml:"rules"`
}
The rule-based properties of an ID namespace.
These properties define how the ID namespace can be used in an ID mapping workflow.
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"
namespaceRuleBasedPropertiesProperty := &NamespaceRuleBasedPropertiesProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
RecordMatchingModels: []*string{
jsii.String("recordMatchingModels"),
},
RuleDefinitionTypes: []*string{
jsii.String("ruleDefinitionTypes"),
},
Rules: []interface{}{
&RuleProperty{
MatchingKeys: []*string{
jsii.String("matchingKeys"),
},
RuleName: jsii.String("ruleName"),
},
},
}
type CfnIdNamespace_RuleProperty ¶ added in v2.154.0
type CfnIdNamespace_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-idnamespace-rule.html#cfn-entityresolution-idnamespace-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-idnamespace-rule.html#cfn-entityresolution-idnamespace-rule-rulename
//
RuleName *string `field:"required" json:"ruleName" yaml:"ruleName"`
}
An object containing the `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 CfnMatchingWorkflow ¶
type CfnMatchingWorkflow interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsentityresolution.IMatchingWorkflowRef
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A description of the workflow.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// Optional.
IncrementalRunConfig() interface{}
SetIncrementalRunConfig(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
// A reference to a MatchingWorkflow resource.
MatchingWorkflowRef() *interfacesawsentityresolution.MatchingWorkflowReference
// The tree node.
Node() constructs.Node
// A list of `OutputSource` objects, each of which contains fields `outputS3Path` , `applyNormalization` , `KMSArn` , 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 matching workflow that defines the configuration for a data processing job.
The workflow name must be unique. To modify an existing workflow, use `UpdateMatchingWorkflow` .
> For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported.
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"),
},
},
// the properties below are optional
MatchPurpose: jsii.String("matchPurpose"),
},
RuleConditionProperties: &RuleConditionPropertiesProperty{
Rules: []interface{}{
&RuleConditionProperty{
Condition: jsii.String("condition"),
RuleName: jsii.String("ruleName"),
},
},
},
},
RoleArn: jsii.String("roleArn"),
WorkflowName: jsii.String("workflowName"),
// the properties below are optional
Description: jsii.String("description"),
IncrementalRunConfig: &IncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnMatchingWorkflow ¶
func NewCfnMatchingWorkflow(scope constructs.Construct, id *string, props *CfnMatchingWorkflowProps) CfnMatchingWorkflow
Create a new `AWS::EntityResolution::MatchingWorkflow`.
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` , `KMSArn` , 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"`
// Optional.
//
// An object that defines the incremental run type. This object contains only the `incrementalRunType` field, which appears as "Automatic" in the console.
//
// > For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-incrementalrunconfig
//
IncrementalRunConfig interface{} `field:"optional" json:"incrementalRunConfig" yaml:"incrementalRunConfig"`
// 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"),
},
},
// the properties below are optional
MatchPurpose: jsii.String("matchPurpose"),
},
RuleConditionProperties: &RuleConditionPropertiesProperty{
Rules: []interface{}{
&RuleConditionProperty{
Condition: jsii.String("condition"),
RuleName: jsii.String("ruleName"),
},
},
},
},
RoleArn: jsii.String("roleArn"),
WorkflowName: jsii.String("workflowName"),
// the properties below are optional
Description: jsii.String("description"),
IncrementalRunConfig: &IncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnMatchingWorkflow_IncrementalRunConfigProperty ¶ added in v2.157.0
type CfnMatchingWorkflow_IncrementalRunConfigProperty struct {
// The type of incremental run. The only valid value is `IMMEDIATE` . This appears as "Automatic" in the console.
//
// > For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-incrementalrunconfig.html#cfn-entityresolution-matchingworkflow-incrementalrunconfig-incrementalruntype
//
IncrementalRunType *string `field:"required" json:"incrementalRunType" yaml:"incrementalRunType"`
}
Optional.
An object that defines the incremental run type. This object contains only the `incrementalRunType` field, which appears as "Automatic" in the console.
> For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported.
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"
incrementalRunConfigProperty := &IncrementalRunConfigProperty{
IncrementalRunType: jsii.String("incrementalRunType"),
}
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 workflow to create. Specify one of the following types:.
//
// - `RULE_MATCHING` : Match records using configurable rule-based criteria
// - `ML_MATCHING` : Match records using machine learning models
// - `PROVIDER` : Match records using a third-party matching provider.
// 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 containing the `rules` for a matching workflow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-ruleconditionproperties
//
RuleConditionProperties interface{} `field:"optional" json:"ruleConditionProperties" yaml:"ruleConditionProperties"`
}
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"),
},
},
// the properties below are optional
MatchPurpose: jsii.String("matchPurpose"),
},
RuleConditionProperties: &RuleConditionPropertiesProperty{
Rules: []interface{}{
&RuleConditionProperty{
Condition: jsii.String("condition"),
RuleName: jsii.String("ruleName"),
},
},
},
}
type CfnMatchingWorkflow_RuleBasedPropertiesProperty ¶
type CfnMatchingWorkflow_RuleBasedPropertiesProperty struct {
// The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .
//
// If you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.
//
// If you choose `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` attribute 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 indicator of whether to generate IDs and index the data or not.
//
// If you choose `IDENTIFIER_GENERATION` , the process generates IDs and indexes the data.
//
// If you choose `INDEXING` , the process indexes the data without generating IDs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-matchpurpose
//
MatchPurpose *string `field:"optional" json:"matchPurpose" yaml:"matchPurpose"`
}
An object which defines the list of matching rules to run in a matching workflow.
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"),
},
},
// the properties below are optional
MatchPurpose: jsii.String("matchPurpose"),
}
type CfnMatchingWorkflow_RuleConditionPropertiesProperty ¶ added in v2.211.0
type CfnMatchingWorkflow_RuleConditionPropertiesProperty struct {
// A list of rule objects, each of which have fields `ruleName` and `condition` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.html#cfn-entityresolution-matchingworkflow-ruleconditionproperties-rules
//
Rules interface{} `field:"required" json:"rules" yaml:"rules"`
}
The properties of a rule condition that provides the ability to use more complex syntax.
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"
ruleConditionPropertiesProperty := &RuleConditionPropertiesProperty{
Rules: []interface{}{
&RuleConditionProperty{
Condition: jsii.String("condition"),
RuleName: jsii.String("ruleName"),
},
},
}
type CfnMatchingWorkflow_RuleConditionProperty ¶ added in v2.211.0
type CfnMatchingWorkflow_RuleConditionProperty struct {
// A statement that specifies the conditions for a matching rule.
//
// If your data is accurate, use an Exact matching function: `Exact` or `ExactManyToMany` .
//
// If your data has variations in spelling or pronunciation, use a Fuzzy matching function: `Cosine` , `Levenshtein` , or `Soundex` .
//
// Use operators if you want to combine ( `AND` ), separate ( `OR` ), or group matching functions `(...)` .
//
// For example: `(Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-condition
//
Condition *string `field:"optional" json:"condition" yaml:"condition"`
// A name for the matching rule.
//
// For example: `Rule1`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-rulename
//
RuleName *string `field:"optional" json:"ruleName" yaml:"ruleName"`
}
An object that defines the `ruleCondition` and the `ruleName` to use in a matching workflow.
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"
ruleConditionProperty := &RuleConditionProperty{
Condition: jsii.String("condition"),
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 the `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 CfnPolicyStatement ¶ added in v2.138.0
type CfnPolicyStatement interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsentityresolution.IPolicyStatementRef
// The action that the principal can use on the resource.
Action() *[]*string
SetAction(val *[]*string)
// The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
Arn() *string
SetArn(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// A set of condition keys that you can use in key policies.
Condition() *string
SetCondition(val *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
// Determines whether the permissions specified in the policy are to be allowed ( `Allow` ) or denied ( `Deny` ).
Effect() *string
SetEffect(val *string)
Env() *interfaces.ResourceEnvironment
// 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 reference to a PolicyStatement resource.
PolicyStatementRef() *interfacesawsentityresolution.PolicyStatementReference
// The AWS service or AWS account that can access the resource defined as ARN.
Principal() *[]*string
SetPrincipal(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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A statement identifier that differentiates the statement from others in the same policy.
StatementId() *string
SetStatementId(val *string)
// 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{})
}
Adds a policy statement object.
To retrieve a list of existing policy statements, use the `GetPolicy` 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"
cfnPolicyStatement := awscdk.Aws_entityresolution.NewCfnPolicyStatement(this, jsii.String("MyCfnPolicyStatement"), &CfnPolicyStatementProps{
Arn: jsii.String("arn"),
StatementId: jsii.String("statementId"),
// the properties below are optional
Action: []*string{
jsii.String("action"),
},
Condition: jsii.String("condition"),
Effect: jsii.String("effect"),
Principal: []*string{
jsii.String("principal"),
},
})
func NewCfnPolicyStatement ¶ added in v2.138.0
func NewCfnPolicyStatement(scope constructs.Construct, id *string, props *CfnPolicyStatementProps) CfnPolicyStatement
Create a new `AWS::EntityResolution::PolicyStatement`.
type CfnPolicyStatementProps ¶ added in v2.138.0
type CfnPolicyStatementProps struct {
// The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-arn
//
Arn *string `field:"required" json:"arn" yaml:"arn"`
// A statement identifier that differentiates the statement from others in the same policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-statementid
//
StatementId *string `field:"required" json:"statementId" yaml:"statementId"`
// The action that the principal can use on the resource.
//
// For example, `entityresolution:GetIdMappingJob` , `entityresolution:GetMatchingJob` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-action
//
Action *[]*string `field:"optional" json:"action" yaml:"action"`
// A set of condition keys that you can use in key policies.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-condition
//
Condition *string `field:"optional" json:"condition" yaml:"condition"`
// Determines whether the permissions specified in the policy are to be allowed ( `Allow` ) or denied ( `Deny` ).
//
// > If you set the value of the `effect` parameter to `Deny` for the `AddPolicyStatement` operation, you must also set the value of the `effect` parameter in the `policy` to `Deny` for the `PutPolicy` operation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-effect
//
Effect *string `field:"optional" json:"effect" yaml:"effect"`
// The AWS service or AWS account that can access the resource defined as ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-policystatement.html#cfn-entityresolution-policystatement-principal
//
Principal *[]*string `field:"optional" json:"principal" yaml:"principal"`
}
Properties for defining a `CfnPolicyStatement`.
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"
cfnPolicyStatementProps := &CfnPolicyStatementProps{
Arn: jsii.String("arn"),
StatementId: jsii.String("statementId"),
// the properties below are optional
Action: []*string{
jsii.String("action"),
},
Condition: jsii.String("condition"),
Effect: jsii.String("effect"),
Principal: []*string{
jsii.String("principal"),
},
}
type CfnSchemaMapping ¶
type CfnSchemaMapping interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsentityresolution.ISchemaMappingRef
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A description of the schema.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// 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
// A reference to a SchemaMapping resource.
SchemaMappingRef() *interfacesawsentityresolution.SchemaMappingReference
// 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"),
Hashed: jsii.Boolean(false),
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
Create a new `AWS::EntityResolution::SchemaMapping`.
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"),
Hashed: jsii.Boolean(false),
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.
//
// LiveRamp supports: `NAME` | `NAME_FIRST` | `NAME_MIDDLE` | `NAME_LAST` | `ADDRESS` | `ADDRESS_STREET1` | `ADDRESS_STREET2` | `ADDRESS_STREET3` | `ADDRESS_CITY` | `ADDRESS_STATE` | `ADDRESS_COUNTRY` | `ADDRESS_POSTALCODE` | `PHONE` | `PHONE_NUMBER` | `EMAIL_ADDRESS` | `UNIQUE_ID` | `PROVIDER_ID`
//
// TransUnion supports: `NAME` | `NAME_FIRST` | `NAME_LAST` | `ADDRESS` | `ADDRESS_CITY` | `ADDRESS_STATE` | `ADDRESS_COUNTRY` | `ADDRESS_POSTALCODE` | `PHONE_NUMBER` | `EMAIL_ADDRESS` | `UNIQUE_ID` | `IPV4` | `IPV6` | `MAID`
//
// Unified ID 2.0 supports: `PHONE_NUMBER` | `EMAIL_ADDRESS` | `UNIQUE_ID`
//
// > Normalization is only supported for `NAME` , `ADDRESS` , `PHONE` , and `EMAIL_ADDRESS` .
// >
// > If you want to normalize `NAME_FIRST` , `NAME_MIDDLE` , and `NAME_LAST` , you must group them by assigning them to the `NAME` `groupName` .
// >
// > If you want to normalize `ADDRESS_STREET1` , `ADDRESS_STREET2` , `ADDRESS_STREET3` , `ADDRESS_CITY` , `ADDRESS_STATE` , `ADDRESS_COUNTRY` , and `ADDRESS_POSTALCODE` , you must group them by assigning them to the `ADDRESS` `groupName` .
// >
// > If you want to normalize `PHONE_NUMBER` and `PHONE_COUNTRYCODE` , you must group them by assigning them to the `PHONE` `groupName` .
// 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"`
// A string that instructs AWS Entity Resolution to combine several columns into a unified column with the identical attribute type.
//
// For example, when working with columns such as `NAME_FIRST` , `NAME_MIDDLE` , and `NAME_LAST` , 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"`
// Indicates if the column values are hashed in the schema input.
//
// If the value is set to `TRUE` , the column values are hashed.
//
// If the value is set to `FALSE` , the column values are cleartext.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-schemamapping-schemainputattribute.html#cfn-entityresolution-schemamapping-schemainputattribute-hashed
//
Hashed interface{} `field:"optional" json:"hashed" yaml:"hashed"`
// A key that allows grouping of multiple input attributes into a unified matching group.
//
// For example, consider a scenario where the source table contains various addresses, such as `business_address` and `shipping_address` . By assigning a `matchKey` called `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"`
}
A configuration object for defining input data fields in AWS Entity Resolution .
The `SchemaInputAttribute` specifies how individual fields in your input data should be processed and matched.
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"),
Hashed: jsii.Boolean(false),
MatchKey: jsii.String("matchKey"),
SubType: jsii.String("subType"),
}
Source Files
¶
- CfnIdMappingWorkflow.go
- CfnIdMappingWorkflowProps.go
- CfnIdMappingWorkflow_IdMappingIncrementalRunConfigProperty.go
- CfnIdMappingWorkflow_IdMappingRuleBasedPropertiesProperty.go
- CfnIdMappingWorkflow_IdMappingTechniquesProperty.go
- CfnIdMappingWorkflow_IdMappingWorkflowInputSourceProperty.go
- CfnIdMappingWorkflow_IdMappingWorkflowOutputSourceProperty.go
- CfnIdMappingWorkflow_IntermediateSourceConfigurationProperty.go
- CfnIdMappingWorkflow_ProviderPropertiesProperty.go
- CfnIdMappingWorkflow_RuleProperty.go
- CfnIdMappingWorkflow__checks.go
- CfnIdNamespace.go
- CfnIdNamespaceProps.go
- CfnIdNamespace_IdNamespaceIdMappingWorkflowPropertiesProperty.go
- CfnIdNamespace_IdNamespaceInputSourceProperty.go
- CfnIdNamespace_NamespaceProviderPropertiesProperty.go
- CfnIdNamespace_NamespaceRuleBasedPropertiesProperty.go
- CfnIdNamespace_RuleProperty.go
- CfnIdNamespace__checks.go
- CfnMatchingWorkflow.go
- CfnMatchingWorkflowProps.go
- CfnMatchingWorkflow_IncrementalRunConfigProperty.go
- CfnMatchingWorkflow_InputSourceProperty.go
- CfnMatchingWorkflow_IntermediateSourceConfigurationProperty.go
- CfnMatchingWorkflow_OutputAttributeProperty.go
- CfnMatchingWorkflow_OutputSourceProperty.go
- CfnMatchingWorkflow_ProviderPropertiesProperty.go
- CfnMatchingWorkflow_ResolutionTechniquesProperty.go
- CfnMatchingWorkflow_RuleBasedPropertiesProperty.go
- CfnMatchingWorkflow_RuleConditionPropertiesProperty.go
- CfnMatchingWorkflow_RuleConditionProperty.go
- CfnMatchingWorkflow_RuleProperty.go
- CfnMatchingWorkflow__checks.go
- CfnPolicyStatement.go
- CfnPolicyStatementProps.go
- CfnPolicyStatement__checks.go
- CfnSchemaMapping.go
- CfnSchemaMappingProps.go
- CfnSchemaMapping_SchemaInputAttributeProperty.go
- CfnSchemaMapping__checks.go
- main.go