Package software.amazon.awscdk.services.cleanrooms

Interface CfnAnalysisTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.299Z")
@Stability(Stable)
public interface CfnAnalysisTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAnalysisTemplate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cleanrooms.*;
 CfnAnalysisTemplateProps cfnAnalysisTemplateProps = CfnAnalysisTemplateProps.builder()
         .format("format")
         .membershipIdentifier("membershipIdentifier")
         .name("name")
         .source(AnalysisSourceProperty.builder()
                 .text("text")
                 .build())
         // the properties below are optional
         .analysisParameters(List.of(AnalysisParameterProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .defaultValue("defaultValue")
                 .build()))
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAnalysisTemplateProps.Builder	A builder for CfnAnalysisTemplateProps
static final class	CfnAnalysisTemplateProps.Jsii$Proxy	An implementation for CfnAnalysisTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnAnalysisTemplateProps.Builder	builder()
default Object	getAnalysisParameters()	The parameters of the analysis template.
default String	getDescription()	The description of the analysis template.
String	getFormat()	The format of the analysis template.
String	getMembershipIdentifier()	The identifier for a membership resource.
String	getName()	The name of the analysis template.
Object	getSource()	The source of the analysis template.
default List<CfnTag>	getTags()	An optional label that you can assign to a resource when you create it.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFormat

@Stability(Stable)
@NotNull
String getFormat()

The format of the analysis template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format

getMembershipIdentifier

@Stability(Stable)
@NotNull
String getMembershipIdentifier()

The identifier for a membership resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier

getName

@Stability(Stable)
@NotNull
String getName()

The name of the analysis template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name

getSource

@Stability(Stable)
@NotNull
Object getSource()

The source of the analysis template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source

getAnalysisParameters

@Stability(Stable)
@Nullable
default Object getAnalysisParameters()

The parameters of the analysis template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the analysis template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An optional label that you can assign to a resource when you create it.

Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags

builder

@Stability(Stable)
static CfnAnalysisTemplateProps.Builder builder()

Returns:

a CfnAnalysisTemplateProps.Builder of CfnAnalysisTemplateProps