CfnConfiguredTableAssociation
- class aws_cdk.aws_cleanrooms.CfnConfiguredTableAssociation(scope, id, *, configured_table_identifier, membership_identifier, name, role_arn, configured_table_association_analysis_rules=None, description=None, tags=None)
Bases:
CfnResource
Creates a configured table association.
A configured table association links a configured table with a collaboration.
- See:
- CloudformationResource:
AWS::CleanRooms::ConfiguredTableAssociation
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms cfn_configured_table_association = cleanrooms.CfnConfiguredTableAssociation(self, "MyCfnConfiguredTableAssociation", configured_table_identifier="configuredTableIdentifier", membership_identifier="membershipIdentifier", name="name", role_arn="roleArn", # the properties below are optional configured_table_association_analysis_rules=[cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleProperty( policy=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyProperty( v1=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property( aggregation=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), custom=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), list=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ) ) ), type="type" )], description="description", tags=[CfnTag( key="key", value="value" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).configured_table_identifier (
str
) – A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.membership_identifier (
str
) – The unique ID for the membership this configured table association belongs to.name (
str
) – The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.role_arn (
str
) – The service will assume this role to access catalog metadata and query the table.configured_table_association_analysis_rules (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ConfiguredTableAssociationAnalysisRuleProperty
,Dict
[str
,Any
]]],None
]) – An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, theConfiguredTableAssociationAnalysisRule
is referred to as the collaboration analysis rule .description (
Optional
[str
]) – A description of the configured table association.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CleanRooms::ConfiguredTableAssociation'
- attr_arn
Returns the Amazon Resource Name (ARN) of the specified configured table association.
Example:
arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- CloudformationAttribute:
Arn
- attr_configured_table_association_identifier
Returns the unique identifier of the specified configured table association.
Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
- CloudformationAttribute:
ConfiguredTableAssociationIdentifier
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- configured_table_association_analysis_rules
An analysis rule for a configured table association.
- configured_table_identifier
A unique identifier for the configured table to be associated to.
- creation_stack
return:
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.
- description
A description of the configured table association.
- logical_id
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.
- membership_identifier
The unique ID for the membership this configured table association belongs to.
- name
The name of the configured table association, in lowercase.
- node
The tree node.
- ref
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 })
.
- role_arn
The service will assume this role to access catalog metadata and query the table.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
An optional label that you can assign to a resource when you create it.
Static Methods
- classmethod is_cfn_element(x)
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.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
ConfiguredTableAssociationAnalysisRuleAggregationProperty
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)
Bases:
object
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
- Parameters:
allowed_additional_analyses (
Optional
[Sequence
[str
]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output. TheallowedAdditionalAnalyses
parameter is currently supported for the list analysis rule (AnalysisRuleList
) and the custom analysis rule (AnalysisRuleCustom
).allowed_result_receivers (
Optional
[Sequence
[str
]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_aggregation_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] )
Attributes
- allowed_additional_analyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
The
allowedAdditionalAnalyses
parameter is currently supported for the list analysis rule (AnalysisRuleList
) and the custom analysis rule (AnalysisRuleCustom
).
- allowed_result_receivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
ConfiguredTableAssociationAnalysisRuleCustomProperty
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)
Bases:
object
The configured table association analysis rule applied to a configured table with the custom analysis rule.
- Parameters:
allowed_additional_analyses (
Optional
[Sequence
[str
]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.allowed_result_receivers (
Optional
[Sequence
[str
]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_custom_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] )
Attributes
- allowed_additional_analyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
- allowed_result_receivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
ConfiguredTableAssociationAnalysisRuleListProperty
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty(*, allowed_additional_analyses=None, allowed_result_receivers=None)
Bases:
object
The configured table association analysis rule applied to a configured table with the list analysis rule.
- Parameters:
allowed_additional_analyses (
Optional
[Sequence
[str
]]) – The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.allowed_result_receivers (
Optional
[Sequence
[str
]]) – The list of collaboration members who are allowed to receive results of queries run with this configured table.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_list_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] )
Attributes
- allowed_additional_analyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
- allowed_result_receivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
ConfiguredTableAssociationAnalysisRulePolicyProperty
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyProperty(*, v1)
Bases:
object
Controls on the query specifications that can be run on an associated configured table.
- Parameters:
v1 (
Union
[IResolvable
,ConfiguredTableAssociationAnalysisRulePolicyV1Property
,Dict
[str
,Any
]]) – The policy for the configured table association analysis rule.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_policy_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyProperty( v1=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property( aggregation=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), custom=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), list=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ) ) )
Attributes
- v1
The policy for the configured table association analysis rule.
ConfiguredTableAssociationAnalysisRulePolicyV1Property
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property(*, aggregation=None, custom=None, list=None)
Bases:
object
Controls on the query specifications that can be run on an associated configured table.
- Parameters:
aggregation (
Union
[IResolvable
,ConfiguredTableAssociationAnalysisRuleAggregationProperty
,Dict
[str
,Any
],None
]) – Analysis rule type that enables only aggregation queries on a configured table.custom (
Union
[IResolvable
,ConfiguredTableAssociationAnalysisRuleCustomProperty
,Dict
[str
,Any
],None
]) – Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.list (
Union
[IResolvable
,ConfiguredTableAssociationAnalysisRuleListProperty
,Dict
[str
,Any
],None
]) – Analysis rule type that enables only list queries on a configured table.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_policy_v1_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property( aggregation=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), custom=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), list=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ) )
Attributes
- aggregation
Analysis rule type that enables only aggregation queries on a configured table.
- custom
Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables.
It supports differential privacy.
- list
Analysis rule type that enables only list queries on a configured table.
ConfiguredTableAssociationAnalysisRuleProperty
- class CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleProperty(*, policy, type)
Bases:
object
An analysis rule for a configured table association.
This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the
ConfiguredTableAssociationAnalysisRule
is referred to as the collaboration analysis rule .- Parameters:
policy (
Union
[IResolvable
,ConfiguredTableAssociationAnalysisRulePolicyProperty
,Dict
[str
,Any
]]) – The policy of the configured table association analysis rule.type (
str
) – The type of the configured table association analysis rule.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cleanrooms as cleanrooms configured_table_association_analysis_rule_property = cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleProperty( policy=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyProperty( v1=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRulePolicyV1Property( aggregation=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleAggregationProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), custom=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleCustomProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ), list=cleanrooms.CfnConfiguredTableAssociation.ConfiguredTableAssociationAnalysisRuleListProperty( allowed_additional_analyses=["allowedAdditionalAnalyses"], allowed_result_receivers=["allowedResultReceivers"] ) ) ), type="type" )
Attributes
- policy
The policy of the configured table association analysis rule.
- type
The type of the configured table association analysis rule.