CfnCollaboration

class aws_cdk.aws_cleanrooms.CfnCollaboration(scope, id, *, creator_display_name, creator_member_abilities, description, members, name, query_log_status, creator_payment_configuration=None, data_encryption_metadata=None, tags=None)

Bases: CfnResource

Creates a new collaboration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html
CloudformationResource:: AWS::CleanRooms::Collaboration
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_collaboration = cleanrooms.CfnCollaboration(self, "MyCfnCollaboration",
    creator_display_name="creatorDisplayName",
    creator_member_abilities=["creatorMemberAbilities"],
    description="description",
    members=[cleanrooms.CfnCollaboration.MemberSpecificationProperty(
        account_id="accountId",
        display_name="displayName",
        member_abilities=["memberAbilities"],

        # the properties below are optional
        payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
            query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
                is_responsible=False
            )
        )
    )],
    name="name",
    query_log_status="queryLogStatus",

    # the properties below are optional
    creator_payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
        query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
            is_responsible=False
        )
    ),
    data_encryption_metadata=cleanrooms.CfnCollaboration.DataEncryptionMetadataProperty(
        allow_cleartext=False,
        allow_duplicates=False,
        allow_joins_on_columns_with_different_names=False,
        preserve_nulls=False
    ),
    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).
creator_display_name (str) – A display name of the collaboration creator.
creator_member_abilities (Sequence[str]) – The abilities granted to the collaboration creator. Allowed values CAN_QUERY | CAN_RECEIVE_RESULTS
description (str) – A description of the collaboration provided by the collaboration owner.
members (Union[IResolvable, Sequence[Union[IResolvable, MemberSpecificationProperty, Dict[str, Any]]]]) – A list of initial members, not including the creator. This list is immutable.
name (str) – A human-readable identifier provided by the collaboration owner. Display names are not unique.
query_log_status (str) – An indicator as to whether query logging has been enabled or disabled for the collaboration.
creator_payment_configuration (Union[IResolvable, PaymentConfigurationProperty, Dict[str, Any], None]) – An object representing the collaboration member’s payment responsibilities set by the collaboration creator.
data_encryption_metadata (Union[IResolvable, DataEncryptionMetadataProperty, Dict[str, Any], None]) – The settings for client-side encryption for cryptographic computing.
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

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.

add_override(path, value)

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:

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 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.

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: true
default (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:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

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:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

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::Collaboration'

attr_arn

Returns the Amazon Resource Name (ARN) of the specified collaboration.

Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

CloudformationAttribute:: Arn

attr_collaboration_identifier

Returns the unique identifier of the specified collaboration.

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

CloudformationAttribute:: CollaborationIdentifier

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.

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.

creator_display_name: A display name of the collaboration creator.

creator_member_abilities: The abilities granted to the collaboration creator.

creator_payment_configuration: An object representing the collaboration member’s payment responsibilities set by the collaboration creator.

data_encryption_metadata: The settings for client-side encryption for cryptographic computing.

description: A description of the collaboration provided by the collaboration owner.

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.

members: A list of initial members, not including the creator.

name: A human-readable identifier provided by the collaboration owner.

node: The tree node.

query_log_status: An indicator as to whether query logging has been enabled or disabled for the collaboration.

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 }).

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 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.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DataEncryptionMetadataProperty

class CfnCollaboration.DataEncryptionMetadataProperty(*, allow_cleartext, allow_duplicates, allow_joins_on_columns_with_different_names, preserve_nulls)

Bases: object

The settings for client-side encryption for cryptographic computing.

Parameters:

allow_cleartext (Union[bool, IResolvable]) – Indicates whether encrypted tables can contain cleartext data ( TRUE ) or are to cryptographically process every column ( FALSE ).
allow_duplicates (Union[bool, IResolvable]) – Indicates whether Fingerprint columns can contain duplicate entries ( TRUE ) or are to contain only non-repeated values ( FALSE ).
allow_joins_on_columns_with_different_names (Union[bool, IResolvable]) – Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE ) or can only be joined on Fingerprint columns of the same name ( FALSE ).
preserve_nulls (Union[bool, IResolvable]) – Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE ) or cryptographically processed ( FALSE ).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html

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

data_encryption_metadata_property = cleanrooms.CfnCollaboration.DataEncryptionMetadataProperty(
    allow_cleartext=False,
    allow_duplicates=False,
    allow_joins_on_columns_with_different_names=False,
    preserve_nulls=False
)

Attributes

allow_cleartext

Indicates whether encrypted tables can contain cleartext data ( TRUE ) or are to cryptographically process every column ( FALSE ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext

allow_duplicates

Indicates whether Fingerprint columns can contain duplicate entries ( TRUE ) or are to contain only non-repeated values ( FALSE ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates

allow_joins_on_columns_with_different_names

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE ) or can only be joined on Fingerprint columns of the same name ( FALSE ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames

preserve_nulls

Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE ) or cryptographically processed ( FALSE ).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls

MemberSpecificationProperty

class CfnCollaboration.MemberSpecificationProperty(*, account_id, display_name, member_abilities, payment_configuration=None)

Bases: object

Basic metadata used to construct a new member.

Parameters:

account_id (str) – The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
display_name (str) – The member’s display name.
member_abilities (Sequence[str]) – The abilities granted to the collaboration member. Allowed Values : CAN_QUERY | CAN_RECEIVE_RESULTS
payment_configuration (Union[IResolvable, PaymentConfigurationProperty, Dict[str, Any], None]) – The collaboration member’s payment responsibilities set by the collaboration creator. If the collaboration creator hasn’t speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html

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

member_specification_property = cleanrooms.CfnCollaboration.MemberSpecificationProperty(
    account_id="accountId",
    display_name="displayName",
    member_abilities=["memberAbilities"],

    # the properties below are optional
    payment_configuration=cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
        query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
            is_responsible=False
        )
    )
)

Attributes

account_id

The identifier used to reference members of the collaboration.

Currently only supports AWS account ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-accountid

display_name

The member’s display name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-displayname

member_abilities

The abilities granted to the collaboration member.

Allowed Values : CAN_QUERY | CAN_RECEIVE_RESULTS

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-memberabilities

payment_configuration

The collaboration member’s payment responsibilities set by the collaboration creator.

If the collaboration creator hasn’t speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration

PaymentConfigurationProperty

class CfnCollaboration.PaymentConfigurationProperty(*, query_compute)

Bases: object

An object representing the collaboration member’s payment responsibilities set by the collaboration creator.

Parameters:: query_compute (Union[IResolvable, QueryComputePaymentConfigProperty, Dict[str, Any]]) – The collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html
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

payment_configuration_property = cleanrooms.CfnCollaboration.PaymentConfigurationProperty(
    query_compute=cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
        is_responsible=False
    )
)

Attributes

query_compute

The collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute

QueryComputePaymentConfigProperty

class CfnCollaboration.QueryComputePaymentConfigProperty(*, is_responsible)

Bases: object

An object representing the collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.

Parameters:: is_responsible (Union[bool, IResolvable]) – Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE ) or has not configured the collaboration member to pay for query compute costs ( FALSE ). Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html
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

query_compute_payment_config_property = cleanrooms.CfnCollaboration.QueryComputePaymentConfigProperty(
    is_responsible=False
)

Attributes

is_responsible

Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE ) or has not configured the collaboration member to pay for query compute costs ( FALSE ).

Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible