AWS Cloud Control v1.28.0, May 19 25

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.cleanrooms.AnalysisTemplate

Explore with Pulumi AI

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi

pulumi/pulumi-aws-native

Create AnalysisTemplate Resource

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

Constructor syntax

new AnalysisTemplate(name: string, args: AnalysisTemplateArgs, opts?: CustomResourceOptions);

@overload
def AnalysisTemplate(resource_name: str,
                     args: AnalysisTemplateArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AnalysisTemplate(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     format: Optional[AnalysisTemplateFormat] = None,
                     membership_identifier: Optional[str] = None,
                     source: Optional[Union[AnalysisTemplateAnalysisSource0PropertiesArgs, AnalysisTemplateAnalysisSource1PropertiesArgs]] = None,
                     analysis_parameters: Optional[Sequence[AnalysisTemplateAnalysisParameterArgs]] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     schema: Optional[AnalysisTemplateAnalysisSchemaArgs] = None,
                     source_metadata: Optional[AnalysisTemplateAnalysisSourceMetadataPropertiesArgs] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewAnalysisTemplate(ctx *Context, name string, args AnalysisTemplateArgs, opts ...ResourceOption) (*AnalysisTemplate, error)

public AnalysisTemplate(string name, AnalysisTemplateArgs args, CustomResourceOptions? opts = null)

public AnalysisTemplate(String name, AnalysisTemplateArgs args)
public AnalysisTemplate(String name, AnalysisTemplateArgs args, CustomResourceOptions options)

type: aws-native:cleanrooms:AnalysisTemplate
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 AnalysisTemplateArgs: 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 AnalysisTemplateArgs: 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 AnalysisTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AnalysisTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AnalysisTemplateArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AnalysisTemplate 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 AnalysisTemplate resource accepts the following input properties:

Format Pulumi.AwsNative.CleanRooms.AnalysisTemplateFormat: The format of the analysis template.
MembershipIdentifier string: The identifier for a membership resource.
Source Pulumi.AwsNative.CleanRooms.Inputs.AnalysisTemplateAnalysisSource0Properties | Pulumi.AwsNative.CleanRooms.Inputs.AnalysisTemplateAnalysisSource1Properties: The source of the analysis template.
AnalysisParameters List<Pulumi.AwsNative.CleanRooms.Inputs.AnalysisTemplateAnalysisParameter>: The member who can query can provide this placeholder for a literal data value in an analysis template
Description string: The description of the analysis template.
Name string: The name of the analysis template.
Schema Pulumi.AwsNative.CleanRooms.Inputs.AnalysisTemplateAnalysisSchema: The entire schema object.
SourceMetadata Pulumi.AwsNative.CleanRooms.Inputs.AnalysisTemplateAnalysisSourceMetadataProperties: The source metadata for the analysis template.
Tags List<Pulumi.AwsNative.Inputs.Tag>: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

Format AnalysisTemplateFormat: The format of the analysis template.
MembershipIdentifier string: The identifier for a membership resource.
Source AnalysisTemplateAnalysisSource0PropertiesArgs | AnalysisTemplateAnalysisSource1PropertiesArgs: The source of the analysis template.
AnalysisParameters []AnalysisTemplateAnalysisParameterArgs: The member who can query can provide this placeholder for a literal data value in an analysis template
Description string: The description of the analysis template.
Name string: The name of the analysis template.
Schema AnalysisTemplateAnalysisSchemaArgs: The entire schema object.
SourceMetadata AnalysisTemplateAnalysisSourceMetadataPropertiesArgs: The source metadata for the analysis template.
Tags TagArgs: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

format AnalysisTemplateFormat: The format of the analysis template.
membershipIdentifier String: The identifier for a membership resource.
source AnalysisTemplateAnalysisSource0Properties | AnalysisTemplateAnalysisSource1Properties: The source of the analysis template.
analysisParameters List<AnalysisTemplateAnalysisParameter>: The member who can query can provide this placeholder for a literal data value in an analysis template
description String: The description of the analysis template.
name String: The name of the analysis template.
schema AnalysisTemplateAnalysisSchema: The entire schema object.
sourceMetadata AnalysisTemplateAnalysisSourceMetadataProperties: The source metadata for the analysis template.
tags List<Tag>: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

format AnalysisTemplateFormat: The format of the analysis template.
membershipIdentifier string: The identifier for a membership resource.
source AnalysisTemplateAnalysisSource0Properties | AnalysisTemplateAnalysisSource1Properties: The source of the analysis template.
analysisParameters AnalysisTemplateAnalysisParameter[]: The member who can query can provide this placeholder for a literal data value in an analysis template
description string: The description of the analysis template.
name string: The name of the analysis template.
schema AnalysisTemplateAnalysisSchema: The entire schema object.
sourceMetadata AnalysisTemplateAnalysisSourceMetadataProperties: The source metadata for the analysis template.
tags Tag[]: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

format AnalysisTemplateFormat: The format of the analysis template.
membership_identifier str: The identifier for a membership resource.
source AnalysisTemplateAnalysisSource0PropertiesArgs | AnalysisTemplateAnalysisSource1PropertiesArgs: The source of the analysis template.
analysis_parameters Sequence[AnalysisTemplateAnalysisParameterArgs]: The member who can query can provide this placeholder for a literal data value in an analysis template
description str: The description of the analysis template.
name str: The name of the analysis template.
schema AnalysisTemplateAnalysisSchemaArgs: The entire schema object.
source_metadata AnalysisTemplateAnalysisSourceMetadataPropertiesArgs: The source metadata for the analysis template.
tags Sequence[TagArgs]: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

format "SQL" | "PYSPARK_1_0": The format of the analysis template.
membershipIdentifier String: The identifier for a membership resource.
source Property Map | Property Map: The source of the analysis template.
analysisParameters List<Property Map>: The member who can query can provide this placeholder for a literal data value in an analysis template
description String: The description of the analysis template.
name String: The name of the analysis template.
schema Property Map: The entire schema object.
sourceMetadata Property Map: The source metadata for the analysis template.
tags List<Property Map>: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

Outputs

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

AnalysisTemplateIdentifier string

Returns the identifier for the analysis template.

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

Arn string

Returns the Amazon Resource Name (ARN) of the analysis template.

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

CollaborationArn string

Returns the unique ARN for the analysis template’s associated collaboration.

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

CollaborationIdentifier string

Returns the unique ID for the associated collaboration of the analysis template.

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

Id string

The provider-assigned unique ID for this managed resource.

MembershipArn string

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

AnalysisTemplateIdentifier string

Returns the identifier for the analysis template.

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

Arn string

Returns the Amazon Resource Name (ARN) of the analysis template.

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

CollaborationArn string

Returns the unique ARN for the analysis template’s associated collaboration.

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

CollaborationIdentifier string

Returns the unique ID for the associated collaboration of the analysis template.

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

Id string

The provider-assigned unique ID for this managed resource.

MembershipArn string

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

analysisTemplateIdentifier String

Returns the identifier for the analysis template.

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

arn String

Returns the Amazon Resource Name (ARN) of the analysis template.

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

collaborationArn String

Returns the unique ARN for the analysis template’s associated collaboration.

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

collaborationIdentifier String

Returns the unique ID for the associated collaboration of the analysis template.

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

id String

The provider-assigned unique ID for this managed resource.

membershipArn String

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

analysisTemplateIdentifier string

Returns the identifier for the analysis template.

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

arn string

Returns the Amazon Resource Name (ARN) of the analysis template.

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

collaborationArn string

Returns the unique ARN for the analysis template’s associated collaboration.

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

collaborationIdentifier string

Returns the unique ID for the associated collaboration of the analysis template.

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

id string

The provider-assigned unique ID for this managed resource.

membershipArn string

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

analysis_template_identifier str

Returns the identifier for the analysis template.

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

arn str

Returns the Amazon Resource Name (ARN) of the analysis template.

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

collaboration_arn str

Returns the unique ARN for the analysis template’s associated collaboration.

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

collaboration_identifier str

Returns the unique ID for the associated collaboration of the analysis template.

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

id str

The provider-assigned unique ID for this managed resource.

membership_arn str

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

analysisTemplateIdentifier String

Returns the identifier for the analysis template.

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

arn String

Returns the Amazon Resource Name (ARN) of the analysis template.

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

collaborationArn String

Returns the unique ARN for the analysis template’s associated collaboration.

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

collaborationIdentifier String

Returns the unique ID for the associated collaboration of the analysis template.

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

id String

The provider-assigned unique ID for this managed resource.

membershipArn String

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

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

Supporting Types

AnalysisTemplateAnalysisParameter, AnalysisTemplateAnalysisParameterArgs

Name string: The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
Type Pulumi.AwsNative.CleanRooms.AnalysisTemplateAnalysisParameterType: The type of parameter.
DefaultValue string: Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

Name string: The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
Type AnalysisTemplateAnalysisParameterType: The type of parameter.
DefaultValue string: Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

name String: The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
type AnalysisTemplateAnalysisParameterType: The type of parameter.
defaultValue String: Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

name string: The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
type AnalysisTemplateAnalysisParameterType: The type of parameter.
defaultValue string: Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

name str: The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
type AnalysisTemplateAnalysisParameterType: The type of parameter.
default_value str: Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.