CfnMembershipPropsMixin

class aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnMembershipPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a membership for a specific collaboration identifier and joins the collaboration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html

CloudformationResource:

AWS::CleanRooms::Membership

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

cfn_membership_props_mixin = cleanrooms_mixins.CfnMembershipPropsMixin(cleanrooms_mixins.CfnMembershipMixinProps(
    collaboration_identifier="collaborationIdentifier",
    default_job_result_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedJobResultConfigurationProperty(
        output_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedJobOutputConfigurationProperty(
            s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedJobS3OutputConfigurationInputProperty(
                bucket="bucket",
                key_prefix="keyPrefix"
            )
        ),
        role_arn="roleArn"
    ),
    default_result_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedQueryResultConfigurationProperty(
        output_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedQueryOutputConfigurationProperty(
            s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedQueryS3OutputConfigurationProperty(
                bucket="bucket",
                key_prefix="keyPrefix",
                result_format="resultFormat",
                single_file_output=False
            )
        ),
        role_arn="roleArn"
    ),
    job_log_status="jobLogStatus",
    payment_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipPaymentConfigurationProperty(
        job_compute=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipJobComputePaymentConfigProperty(
            is_responsible=False
        ),
        machine_learning=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipMLPaymentConfigProperty(
            model_inference=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelInferencePaymentConfigProperty(
                is_responsible=False
            ),
            model_training=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelTrainingPaymentConfigProperty(
                is_responsible=False
            )
        ),
        query_compute=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipQueryComputePaymentConfigProperty(
            is_responsible=False
        )
    ),
    query_log_status="queryLogStatus",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CleanRooms::Membership.

Parameters:

  • props (Union[CfnMembershipMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['collaborationIdentifier', 'defaultJobResultConfiguration', 'defaultResultConfiguration', 'jobLogStatus', 'paymentConfiguration', 'queryLogStatus', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

MembershipJobComputePaymentConfigProperty

class CfnMembershipPropsMixin.MembershipJobComputePaymentConfigProperty(*, is_responsible=None)

Bases: object

An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.

Parameters:

is_responsible (Union[bool, IResolvable, None]) – Indicates whether the collaboration member has accepted to pay for job compute costs ( TRUE ) or has not accepted to pay for query and job compute costs ( FALSE ). There is only one member who pays for queries and jobs. An error message is returned for the following reasons: - If you set the value to FALSE but you are responsible to pay for query and job compute costs. - If you set the value to TRUE but you are not responsible to pay for query and job compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_job_compute_payment_config_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipJobComputePaymentConfigProperty(
    is_responsible=False
)

Attributes

is_responsible

Indicates whether the collaboration member has accepted to pay for job compute costs ( TRUE ) or has not accepted to pay for query and job compute costs ( FALSE ).

There is only one member who pays for queries and jobs.

An error message is returned for the following reasons:

  • If you set the value to FALSE but you are responsible to pay for query and job compute costs.

  • If you set the value to TRUE but you are not responsible to pay for query and job compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipjobcomputepaymentconfig.html#cfn-cleanrooms-membership-membershipjobcomputepaymentconfig-isresponsible

MembershipMLPaymentConfigProperty

class CfnMembershipPropsMixin.MembershipMLPaymentConfigProperty(*, model_inference=None, model_training=None)

Bases: object

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

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_mLPayment_config_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipMLPaymentConfigProperty(
    model_inference=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelInferencePaymentConfigProperty(
        is_responsible=False
    ),
    model_training=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelTrainingPaymentConfigProperty(
        is_responsible=False
    )
)

Attributes

model_inference

The payment responsibilities accepted by the member for model inference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html#cfn-cleanrooms-membership-membershipmlpaymentconfig-modelinference

model_training

The payment responsibilities accepted by the member for model training.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmlpaymentconfig.html#cfn-cleanrooms-membership-membershipmlpaymentconfig-modeltraining

MembershipModelInferencePaymentConfigProperty

class CfnMembershipPropsMixin.MembershipModelInferencePaymentConfigProperty(*, is_responsible=None)

Bases: object

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

Parameters:

is_responsible (Union[bool, IResolvable, None]) – Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE ) or has not accepted to pay for model inference costs ( FALSE ). If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. An error message is returned for the following reasons: - If you set the value to FALSE but you are responsible to pay for model inference costs. - If you set the value to TRUE but you are not responsible to pay for model inference costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_model_inference_payment_config_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelInferencePaymentConfigProperty(
    is_responsible=False
)

Attributes

is_responsible

Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE ) or has not accepted to pay for model inference costs ( FALSE ).

If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.

An error message is returned for the following reasons:

  • If you set the value to FALSE but you are responsible to pay for model inference costs.

  • If you set the value to TRUE but you are not responsible to pay for model inference costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodelinferencepaymentconfig.html#cfn-cleanrooms-membership-membershipmodelinferencepaymentconfig-isresponsible

MembershipModelTrainingPaymentConfigProperty

class CfnMembershipPropsMixin.MembershipModelTrainingPaymentConfigProperty(*, is_responsible=None)

Bases: object

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

Parameters:

is_responsible (Union[bool, IResolvable, None]) – Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE ) or has not accepted to pay for model training costs ( FALSE ). If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. An error message is returned for the following reasons: - If you set the value to FALSE but you are responsible to pay for model training costs. - If you set the value to TRUE but you are not responsible to pay for model training costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_model_training_payment_config_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelTrainingPaymentConfigProperty(
    is_responsible=False
)

Attributes

is_responsible

Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE ) or has not accepted to pay for model training costs ( FALSE ).

If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.

An error message is returned for the following reasons:

  • If you set the value to FALSE but you are responsible to pay for model training costs.

  • If you set the value to TRUE but you are not responsible to pay for model training costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipmodeltrainingpaymentconfig.html#cfn-cleanrooms-membership-membershipmodeltrainingpaymentconfig-isresponsible

MembershipPaymentConfigurationProperty

class CfnMembershipPropsMixin.MembershipPaymentConfigurationProperty(*, job_compute=None, machine_learning=None, query_compute=None)

Bases: object

An object representing the payment responsibilities accepted by the collaboration member.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_payment_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipPaymentConfigurationProperty(
    job_compute=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipJobComputePaymentConfigProperty(
        is_responsible=False
    ),
    machine_learning=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipMLPaymentConfigProperty(
        model_inference=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelInferencePaymentConfigProperty(
            is_responsible=False
        ),
        model_training=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipModelTrainingPaymentConfigProperty(
            is_responsible=False
        )
    ),
    query_compute=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipQueryComputePaymentConfigProperty(
        is_responsible=False
    )
)

Attributes

job_compute

The payment responsibilities accepted by the collaboration member for job compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-jobcompute

machine_learning

The payment responsibilities accepted by the collaboration member for machine learning costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-machinelearning

query_compute

The payment responsibilities accepted by the collaboration member for query compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-querycompute

MembershipProtectedJobOutputConfigurationProperty

class CfnMembershipPropsMixin.MembershipProtectedJobOutputConfigurationProperty(*, s3=None)

Bases: object

Contains configurations for protected job results.

Parameters:

s3 (Union[IResolvable, ProtectedJobS3OutputConfigurationInputProperty, Dict[str, Any], None]) – Contains the configuration to write the job results to S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_protected_job_output_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedJobOutputConfigurationProperty(
    s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedJobS3OutputConfigurationInputProperty(
        bucket="bucket",
        key_prefix="keyPrefix"
    )
)

Attributes

s3

Contains the configuration to write the job results to S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjoboutputconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjoboutputconfiguration-s3

MembershipProtectedJobResultConfigurationProperty

class CfnMembershipPropsMixin.MembershipProtectedJobResultConfigurationProperty(*, output_configuration=None, role_arn=None)

Bases: object

Contains configurations for protected job results.

Parameters:

  • output_configuration (Union[IResolvable, MembershipProtectedJobOutputConfigurationProperty, Dict[str, Any], None]) – The output configuration for a protected job result.

  • role_arn (Optional[str]) – The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected job results to the result location, given by the member who can receive results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_protected_job_result_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedJobResultConfigurationProperty(
    output_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedJobOutputConfigurationProperty(
        s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedJobS3OutputConfigurationInputProperty(
            bucket="bucket",
            key_prefix="keyPrefix"
        )
    ),
    role_arn="roleArn"
)

Attributes

output_configuration

The output configuration for a protected job result.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-outputconfiguration

role_arn

The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected job results to the result location, given by the member who can receive results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedjobresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedjobresultconfiguration-rolearn

MembershipProtectedQueryOutputConfigurationProperty

class CfnMembershipPropsMixin.MembershipProtectedQueryOutputConfigurationProperty(*, s3=None)

Bases: object

Contains configurations for protected query results.

Parameters:

s3 (Union[IResolvable, ProtectedQueryS3OutputConfigurationProperty, Dict[str, Any], None]) – Required configuration for a protected query with an s3 output type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_protected_query_output_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedQueryOutputConfigurationProperty(
    s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedQueryS3OutputConfigurationProperty(
        bucket="bucket",
        key_prefix="keyPrefix",
        result_format="resultFormat",
        single_file_output=False
    )
)

Attributes

s3

Required configuration for a protected query with an s3 output type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryoutputconfiguration-s3

MembershipProtectedQueryResultConfigurationProperty

class CfnMembershipPropsMixin.MembershipProtectedQueryResultConfigurationProperty(*, output_configuration=None, role_arn=None)

Bases: object

Contains configurations for protected query results.

Parameters:

  • output_configuration (Union[IResolvable, MembershipProtectedQueryOutputConfigurationProperty, Dict[str, Any], None]) – Configuration for protected query results.

  • role_arn (Optional[str]) – The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_protected_query_result_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedQueryResultConfigurationProperty(
    output_configuration=cleanrooms_mixins.CfnMembershipPropsMixin.MembershipProtectedQueryOutputConfigurationProperty(
        s3=cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedQueryS3OutputConfigurationProperty(
            bucket="bucket",
            key_prefix="keyPrefix",
            result_format="resultFormat",
            single_file_output=False
        )
    ),
    role_arn="roleArn"
)

Attributes

output_configuration

Configuration for protected query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-outputconfiguration

role_arn

The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-rolearn

MembershipQueryComputePaymentConfigProperty

class CfnMembershipPropsMixin.MembershipQueryComputePaymentConfigProperty(*, is_responsible=None)

Bases: object

An object representing the payment responsibilities accepted by the collaboration member for query compute costs.

Parameters:

is_responsible (Union[bool, IResolvable, None]) – Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE ) or has not accepted to pay for query compute costs ( FALSE ). If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. An error message is returned for the following reasons: - If you set the value to FALSE but you are responsible to pay for query compute costs. - If you set the value to TRUE but you are not responsible to pay for query compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

membership_query_compute_payment_config_property = cleanrooms_mixins.CfnMembershipPropsMixin.MembershipQueryComputePaymentConfigProperty(
    is_responsible=False
)

Attributes

is_responsible

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

If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.

An error message is returned for the following reasons:

  • If you set the value to FALSE but you are responsible to pay for query compute costs.

  • If you set the value to TRUE but you are not responsible to pay for query compute costs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.html#cfn-cleanrooms-membership-membershipquerycomputepaymentconfig-isresponsible

ProtectedJobS3OutputConfigurationInputProperty

class CfnMembershipPropsMixin.ProtectedJobS3OutputConfigurationInputProperty(*, bucket=None, key_prefix=None)

Bases: object

Contains input information for protected jobs with an S3 output type.

Parameters:

  • bucket (Optional[str]) – The S3 bucket for job output.

  • key_prefix (Optional[str]) – The S3 prefix to unload the protected job results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

protected_job_s3_output_configuration_input_property = cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedJobS3OutputConfigurationInputProperty(
    bucket="bucket",
    key_prefix="keyPrefix"
)

Attributes

bucket

The S3 bucket for job output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-bucket

key_prefix

The S3 prefix to unload the protected job results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedjobs3outputconfigurationinput.html#cfn-cleanrooms-membership-protectedjobs3outputconfigurationinput-keyprefix

ProtectedQueryS3OutputConfigurationProperty

class CfnMembershipPropsMixin.ProtectedQueryS3OutputConfigurationProperty(*, bucket=None, key_prefix=None, result_format=None, single_file_output=None)

Bases: object

Contains the configuration to write the query results to S3.

Parameters:

  • bucket (Optional[str]) – The S3 bucket to unload the protected query results.

  • key_prefix (Optional[str]) – The S3 prefix to unload the protected query results.

  • result_format (Optional[str]) – Intended file format of the result.

  • single_file_output (Union[bool, IResolvable, None]) – Indicates whether files should be output as a single file ( TRUE ) or output as multiple files ( FALSE ). This parameter is only supported for analyses with the Spark analytics engine.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.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.mixins_preview.aws_cleanrooms import mixins as cleanrooms_mixins

protected_query_s3_output_configuration_property = cleanrooms_mixins.CfnMembershipPropsMixin.ProtectedQueryS3OutputConfigurationProperty(
    bucket="bucket",
    key_prefix="keyPrefix",
    result_format="resultFormat",
    single_file_output=False
)

Attributes

bucket

The S3 bucket to unload the protected query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-bucket

key_prefix

The S3 prefix to unload the protected query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-keyprefix

result_format

Intended file format of the result.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-resultformat

single_file_output

Indicates whether files should be output as a single file ( TRUE ) or output as multiple files ( FALSE ).

This parameter is only supported for analyses with the Spark analytics engine.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-singlefileoutput