Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cleanrooms
  5. Membership

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cleanrooms.Membership

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Represents an AWS account that is a part of a collaboration

    Create Membership Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Membership(name: string, args: MembershipArgs, opts?: CustomResourceOptions);
    @overload
def Membership(resource_name: str,
               args: MembershipArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Membership(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               collaboration_identifier: Optional[str] = None,
               query_log_status: Optional[MembershipQueryLogStatus] = None,
               default_result_configuration: Optional[MembershipProtectedQueryResultConfigurationArgs] = None,
               payment_configuration: Optional[MembershipPaymentConfigurationArgs] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewMembership(ctx *Context, name string, args MembershipArgs, opts ...ResourceOption) (*Membership, error)
    public Membership(string name, MembershipArgs args, CustomResourceOptions? opts = null)
    public Membership(String name, MembershipArgs args)
public Membership(String name, MembershipArgs args, CustomResourceOptions options)

    type: aws-native:cleanrooms:Membership
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MembershipArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Membership Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Membership resource accepts the following input properties:

    CollaborationIdentifier string
    The unique ID for the associated collaboration.
    QueryLogStatus Pulumi.AwsNative.CleanRooms.MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    DefaultResultConfiguration Pulumi.AwsNative.CleanRooms.Inputs.MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    PaymentConfiguration Pulumi.AwsNative.CleanRooms.Inputs.MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    CollaborationIdentifier string
    The unique ID for the associated collaboration.
    QueryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    DefaultResultConfiguration MembershipProtectedQueryResultConfigurationArgs
    The default protected query result configuration as specified by the member who can receive results.
    PaymentConfiguration MembershipPaymentConfigurationArgs
    The payment responsibilities accepted by the collaboration member.
    Tags TagArgs
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    collaborationIdentifier String
    The unique ID for the associated collaboration.
    queryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    defaultResultConfiguration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    paymentConfiguration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    collaborationIdentifier string
    The unique ID for the associated collaboration.
    queryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    defaultResultConfiguration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    paymentConfiguration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    collaboration_identifier str
    The unique ID for the associated collaboration.
    query_log_status MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    default_result_configuration MembershipProtectedQueryResultConfigurationArgs
    The default protected query result configuration as specified by the member who can receive results.
    payment_configuration MembershipPaymentConfigurationArgs
    The payment responsibilities accepted by the collaboration member.
    tags Sequence[TagArgs]
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    collaborationIdentifier String
    The unique ID for the associated collaboration.
    queryLogStatus "ENABLED" | "DISABLED"
    An indicator as to whether query logging has been enabled or disabled for the membership.
    defaultResultConfiguration Property Map
    The default protected query result configuration as specified by the member who can receive results.
    paymentConfiguration Property Map
    The payment responsibilities accepted by the collaboration member.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Membership resource produces the following output properties:

    Arn string

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

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

    CollaborationArn string

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

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

    CollaborationCreatorAccountId string

    Returns the unique identifier of the specified collaboration creator account.

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    Arn string

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

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

    CollaborationArn string

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

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

    CollaborationCreatorAccountId string

    Returns the unique identifier of the specified collaboration creator account.

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    arn String

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

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

    collaborationArn String

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

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

    collaborationCreatorAccountId String

    Returns the unique identifier of the specified collaboration creator account.

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

    id String
    The provider-assigned unique ID for this managed resource.
    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    arn string

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

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

    collaborationArn string

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

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

    collaborationCreatorAccountId string

    Returns the unique identifier of the specified collaboration creator account.

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

    id string
    The provider-assigned unique ID for this managed resource.
    membershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    arn str

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

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

    collaboration_arn str

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

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

    collaboration_creator_account_id str

    Returns the unique identifier of the specified collaboration creator account.

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

    id str
    The provider-assigned unique ID for this managed resource.
    membership_identifier str

    Returns the unique identifier of the specified membership.

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

    arn String

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

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

    collaborationArn String

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

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

    collaborationCreatorAccountId String

    Returns the unique identifier of the specified collaboration creator account.

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

    id String
    The provider-assigned unique ID for this managed resource.
    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    Supporting Types

    MembershipPaymentConfiguration, MembershipPaymentConfigurationArgs

    QueryCompute Pulumi.AwsNative.CleanRooms.Inputs.MembershipQueryComputePaymentConfig
    The payment responsibilities accepted by the collaboration member for query compute costs.
    QueryCompute MembershipQueryComputePaymentConfig
    The payment responsibilities accepted by the collaboration member for query compute costs.
    queryCompute MembershipQueryComputePaymentConfig
    The payment responsibilities accepted by the collaboration member for query compute costs.
    queryCompute MembershipQueryComputePaymentConfig
    The payment responsibilities accepted by the collaboration member for query compute costs.
    query_compute MembershipQueryComputePaymentConfig
    The payment responsibilities accepted by the collaboration member for query compute costs.
    queryCompute Property Map
    The payment responsibilities accepted by the collaboration member for query compute costs.

    MembershipProtectedQueryOutputConfiguration, MembershipProtectedQueryOutputConfigurationArgs

    S3 Pulumi.AwsNative.CleanRooms.Inputs.MembershipProtectedQueryS3OutputConfiguration
    Required configuration for a protected query with an s3 output type.
    S3 MembershipProtectedQueryS3OutputConfiguration
    Required configuration for a protected query with an s3 output type.
    s3 MembershipProtectedQueryS3OutputConfiguration
    Required configuration for a protected query with an s3 output type.
    s3 MembershipProtectedQueryS3OutputConfiguration
    Required configuration for a protected query with an s3 output type.
    s3 MembershipProtectedQueryS3OutputConfiguration
    Required configuration for a protected query with an s3 output type.
    s3 Property Map
    Required configuration for a protected query with an s3 output type.

    MembershipProtectedQueryResultConfiguration, MembershipProtectedQueryResultConfigurationArgs

    OutputConfiguration Pulumi.AwsNative.CleanRooms.Inputs.MembershipProtectedQueryOutputConfiguration
    Configuration for protected query results.
    RoleArn string
    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.
    OutputConfiguration MembershipProtectedQueryOutputConfiguration
    Configuration for protected query results.
    RoleArn string
    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.
    outputConfiguration MembershipProtectedQueryOutputConfiguration
    Configuration for protected query results.
    roleArn String
    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.
    outputConfiguration MembershipProtectedQueryOutputConfiguration
    Configuration for protected query results.
    roleArn string
    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.
    output_configuration MembershipProtectedQueryOutputConfiguration
    Configuration for protected query results.
    role_arn 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.
    outputConfiguration Property Map
    Configuration for protected query results.
    roleArn String
    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.

    MembershipProtectedQueryS3OutputConfiguration, MembershipProtectedQueryS3OutputConfigurationArgs

    Bucket string
    The S3 bucket to unload the protected query results.
    ResultFormat Pulumi.AwsNative.CleanRooms.MembershipResultFormat
    Intended file format of the result.
    KeyPrefix string
    The S3 prefix to unload the protected query results.
    SingleFileOutput bool
    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.
    Bucket string
    The S3 bucket to unload the protected query results.
    ResultFormat MembershipResultFormat
    Intended file format of the result.
    KeyPrefix string
    The S3 prefix to unload the protected query results.
    SingleFileOutput bool
    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.
    bucket String
    The S3 bucket to unload the protected query results.
    resultFormat MembershipResultFormat
    Intended file format of the result.
    keyPrefix String
    The S3 prefix to unload the protected query results.
    singleFileOutput Boolean
    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.
    bucket string
    The S3 bucket to unload the protected query results.
    resultFormat MembershipResultFormat
    Intended file format of the result.
    keyPrefix string
    The S3 prefix to unload the protected query results.
    singleFileOutput boolean
    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.
    bucket str
    The S3 bucket to unload the protected query results.
    result_format MembershipResultFormat
    Intended file format of the result.
    key_prefix str
    The S3 prefix to unload the protected query results.
    single_file_output bool
    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.
    bucket String
    The S3 bucket to unload the protected query results.
    resultFormat "CSV" | "PARQUET"
    Intended file format of the result.
    keyPrefix String
    The S3 prefix to unload the protected query results.
    singleFileOutput Boolean
    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.

    MembershipQueryComputePaymentConfig, MembershipQueryComputePaymentConfigArgs

    IsResponsible bool

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

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

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

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

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

    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.

    MembershipQueryLogStatus, MembershipQueryLogStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    MembershipQueryLogStatusEnabled
    ENABLED
    MembershipQueryLogStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    MembershipResultFormat, MembershipResultFormatArgs

    Csv
    CSV
    Parquet
    PARQUET
    MembershipResultFormatCsv
    CSV
    MembershipResultFormatParquet
    PARQUET
    Csv
    CSV
    Parquet
    PARQUET
    Csv
    CSV
    Parquet
    PARQUET
    CSV
    CSV
    PARQUET
    PARQUET
    "CSV"
    CSV
    "PARQUET"
    PARQUET

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native