1. Packages
  2. AWS Native
  3. API Docs
  4. cleanrooms
  5. AnalysisTemplate

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.cleanrooms.AnalysisTemplate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Represents a stored analysis within a collaboration

    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[AnalysisTemplateAnalysisSourceArgs] = None,
                         analysis_parameters: Optional[Sequence[AnalysisTemplateAnalysisParameterArgs]] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const analysisTemplateResource = new aws_native.cleanrooms.AnalysisTemplate("analysisTemplateResource", {
        format: aws_native.cleanrooms.AnalysisTemplateFormat.Sql,
        membershipIdentifier: "string",
        source: {
            text: "string",
        },
        analysisParameters: [{
            name: "string",
            type: aws_native.cleanrooms.AnalysisTemplateAnalysisParameterType.Smallint,
            defaultValue: "string",
        }],
        description: "string",
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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

    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.AnalysisTemplateAnalysisSource
    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.
    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 AnalysisTemplateAnalysisSourceArgs
    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.
    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 AnalysisTemplateAnalysisSource
    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.
    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 AnalysisTemplateAnalysisSource
    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.
    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 AnalysisTemplateAnalysisSourceArgs
    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.
    tags Sequence[TagArgs]
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    format "SQL"
    The format of the analysis template.
    membershipIdentifier String
    The identifier for a membership resource.
    source 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.
    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

    Schema Pulumi.AwsNative.CleanRooms.Outputs.AnalysisTemplateAnalysisSchema
    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

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

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

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

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

    schema Property Map

    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.
    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 "SMALLINT" | "INTEGER" | "BIGINT" | "DECIMAL" | "REAL" | "DOUBLE_PRECISION" | "BOOLEAN" | "CHAR" | "VARCHAR" | "DATE" | "TIMESTAMP" | "TIMESTAMPTZ" | "TIME" | "TIMETZ" | "VARBYTE"
    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.

    AnalysisTemplateAnalysisParameterType, AnalysisTemplateAnalysisParameterTypeArgs

    Smallint
    SMALLINT
    Integer
    INTEGER
    Bigint
    BIGINT
    Decimal
    DECIMAL
    Real
    REAL
    DoublePrecision
    DOUBLE_PRECISION
    Boolean
    BOOLEAN
    Char
    CHAR
    Varchar
    VARCHAR
    Date
    DATE
    Timestamp
    TIMESTAMP
    Timestamptz
    TIMESTAMPTZ
    Time
    TIME
    Timetz
    TIMETZ
    Varbyte
    VARBYTE
    AnalysisTemplateAnalysisParameterTypeSmallint
    SMALLINT
    AnalysisTemplateAnalysisParameterTypeInteger
    INTEGER
    AnalysisTemplateAnalysisParameterTypeBigint
    BIGINT
    AnalysisTemplateAnalysisParameterTypeDecimal
    DECIMAL
    AnalysisTemplateAnalysisParameterTypeReal
    REAL
    AnalysisTemplateAnalysisParameterTypeDoublePrecision
    DOUBLE_PRECISION
    AnalysisTemplateAnalysisParameterTypeBoolean
    BOOLEAN
    AnalysisTemplateAnalysisParameterTypeChar
    CHAR
    AnalysisTemplateAnalysisParameterTypeVarchar
    VARCHAR
    AnalysisTemplateAnalysisParameterTypeDate
    DATE
    AnalysisTemplateAnalysisParameterTypeTimestamp
    TIMESTAMP
    AnalysisTemplateAnalysisParameterTypeTimestamptz
    TIMESTAMPTZ
    AnalysisTemplateAnalysisParameterTypeTime
    TIME
    AnalysisTemplateAnalysisParameterTypeTimetz
    TIMETZ
    AnalysisTemplateAnalysisParameterTypeVarbyte
    VARBYTE
    Smallint
    SMALLINT
    Integer
    INTEGER
    Bigint
    BIGINT
    Decimal
    DECIMAL
    Real
    REAL
    DoublePrecision
    DOUBLE_PRECISION
    Boolean
    BOOLEAN
    Char
    CHAR
    Varchar
    VARCHAR
    Date
    DATE
    Timestamp
    TIMESTAMP
    Timestamptz
    TIMESTAMPTZ
    Time
    TIME
    Timetz
    TIMETZ
    Varbyte
    VARBYTE
    Smallint
    SMALLINT
    Integer
    INTEGER
    Bigint
    BIGINT
    Decimal
    DECIMAL
    Real
    REAL
    DoublePrecision
    DOUBLE_PRECISION
    Boolean
    BOOLEAN
    Char
    CHAR
    Varchar
    VARCHAR
    Date
    DATE
    Timestamp
    TIMESTAMP
    Timestamptz
    TIMESTAMPTZ
    Time
    TIME
    Timetz
    TIMETZ
    Varbyte
    VARBYTE
    SMALLINT
    SMALLINT
    INTEGER
    INTEGER
    BIGINT
    BIGINT
    DECIMAL
    DECIMAL
    REAL
    REAL
    DOUBLE_PRECISION
    DOUBLE_PRECISION
    BOOLEAN
    BOOLEAN
    CHAR
    CHAR
    VARCHAR
    VARCHAR
    DATE
    DATE
    TIMESTAMP
    TIMESTAMP
    TIMESTAMPTZ
    TIMESTAMPTZ
    TIME
    TIME
    TIMETZ
    TIMETZ
    VARBYTE
    VARBYTE
    "SMALLINT"
    SMALLINT
    "INTEGER"
    INTEGER
    "BIGINT"
    BIGINT
    "DECIMAL"
    DECIMAL
    "REAL"
    REAL
    "DOUBLE_PRECISION"
    DOUBLE_PRECISION
    "BOOLEAN"
    BOOLEAN
    "CHAR"
    CHAR
    "VARCHAR"
    VARCHAR
    "DATE"
    DATE
    "TIMESTAMP"
    TIMESTAMP
    "TIMESTAMPTZ"
    TIMESTAMPTZ
    "TIME"
    TIME
    "TIMETZ"
    TIMETZ
    "VARBYTE"
    VARBYTE

    AnalysisTemplateAnalysisSchema, AnalysisTemplateAnalysisSchemaArgs

    ReferencedTables List<string>
    The tables referenced in the analysis schema.
    ReferencedTables []string
    The tables referenced in the analysis schema.
    referencedTables List<String>
    The tables referenced in the analysis schema.
    referencedTables string[]
    The tables referenced in the analysis schema.
    referenced_tables Sequence[str]
    The tables referenced in the analysis schema.
    referencedTables List<String>
    The tables referenced in the analysis schema.

    AnalysisTemplateAnalysisSource, AnalysisTemplateAnalysisSourceArgs

    Text string
    The query text.
    Text string
    The query text.
    text String
    The query text.
    text string
    The query text.
    text str
    The query text.
    text String
    The query text.

    AnalysisTemplateFormat, AnalysisTemplateFormatArgs

    Sql
    SQL
    AnalysisTemplateFormatSql
    SQL
    Sql
    SQL
    Sql
    SQL
    SQL
    SQL
    "SQL"
    SQL

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi