Interface CfnAnalysisTemplateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAnalysisTemplateProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
date="2025-04-22T23:08:08.338Z")
@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()
.artifacts(AnalysisTemplateArtifactsProperty.builder()
.entryPoint(AnalysisTemplateArtifactProperty.builder()
.location(S3LocationProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.roleArn("roleArn")
// the properties below are optional
.additionalArtifacts(List.of(AnalysisTemplateArtifactProperty.builder()
.location(S3LocationProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build()))
.build())
.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")
.schema(AnalysisSchemaProperty.builder()
.referencedTables(List.of("referencedTables"))
.build())
.sourceMetadata(AnalysisSourceMetadataProperty.builder()
.artifacts(AnalysisTemplateArtifactMetadataProperty.builder()
.entryPointHash(HashProperty.builder()
.sha256("sha256")
.build())
// the properties below are optional
.additionalArtifactHashes(List.of(HashProperty.builder()
.sha256("sha256")
.build()))
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAnalysisTemplatePropsstatic final classAn implementation forCfnAnalysisTemplateProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe parameters of the analysis template.default StringThe description of the analysis template.The format of the analysis template.The identifier for a membership resource.getName()The name of the analysis template.default ObjectThe entire schema object.The source of the analysis template.default ObjectThe source metadata for the analysis template.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
The format of the analysis template.- See Also:
-
getMembershipIdentifier
The identifier for a membership resource.- See Also:
-
getName
The name of the analysis template.- See Also:
-
getSource
The source of the analysis template.- See Also:
-
getAnalysisParameters
The parameters of the analysis template.- See Also:
-
getDescription
The description of the analysis template.- See Also:
-
getSchema
The entire schema object.- See Also:
-
getSourceMetadata
The source metadata for the analysis template.- See Also:
-
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:
-
builder
- Returns:
- a
CfnAnalysisTemplateProps.BuilderofCfnAnalysisTemplateProps
-