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

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

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

    Using getMembership

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMembership(args: GetMembershipArgs, opts?: InvokeOptions): Promise<GetMembershipResult>
function getMembershipOutput(args: GetMembershipOutputArgs, opts?: InvokeOptions): Output<GetMembershipResult>
    def get_membership(membership_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetMembershipResult
def get_membership_output(membership_identifier: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetMembershipResult]
    func LookupMembership(ctx *Context, args *LookupMembershipArgs, opts ...InvokeOption) (*LookupMembershipResult, error)
func LookupMembershipOutput(ctx *Context, args *LookupMembershipOutputArgs, opts ...InvokeOption) LookupMembershipResultOutput

    > Note: This function is named LookupMembership in the Go SDK.

    public static class GetMembership 
{
    public static Task<GetMembershipResult> InvokeAsync(GetMembershipArgs args, InvokeOptions? opts = null)
    public static Output<GetMembershipResult> Invoke(GetMembershipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMembershipResult> getMembership(GetMembershipArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cleanrooms:getMembership
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    membershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    membership_identifier str

    Returns the unique identifier of the specified membership.

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

    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    getMembership Result

    The following output properties are available:

    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

    DefaultResultConfiguration Pulumi.AwsNative.CleanRooms.Outputs.MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    PaymentConfiguration Pulumi.AwsNative.CleanRooms.Outputs.MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    QueryLogStatus Pulumi.AwsNative.CleanRooms.MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    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

    DefaultResultConfiguration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    MembershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    PaymentConfiguration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    QueryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    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

    defaultResultConfiguration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    paymentConfiguration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    queryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    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

    defaultResultConfiguration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    membershipIdentifier string

    Returns the unique identifier of the specified membership.

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

    paymentConfiguration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    queryLogStatus MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    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

    default_result_configuration MembershipProtectedQueryResultConfiguration
    The default protected query result configuration as specified by the member who can receive results.
    membership_identifier str

    Returns the unique identifier of the specified membership.

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

    payment_configuration MembershipPaymentConfiguration
    The payment responsibilities accepted by the collaboration member.
    query_log_status MembershipQueryLogStatus
    An indicator as to whether query logging has been enabled or disabled for the membership.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.
    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

    defaultResultConfiguration Property Map
    The default protected query result configuration as specified by the member who can receive results.
    membershipIdentifier String

    Returns the unique identifier of the specified membership.

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

    paymentConfiguration Property Map
    The payment responsibilities accepted by the collaboration member.
    queryLogStatus "ENABLED" | "DISABLED"
    An indicator as to whether query logging has been enabled or disabled for the membership.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this cleanrooms membership.

    Supporting Types

    MembershipPaymentConfiguration

    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

    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

    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

    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

    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

    MembershipResultFormat

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