Class CfnAnalysisTemplate
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cleanrooms.CfnAnalysisTemplate
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:24.508Z")
@Stability(Stable)
public class CfnAnalysisTemplate
extends CfnResource
implements IInspectable, ITaggableV2
Creates a new analysis template.
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.*; CfnAnalysisTemplate cfnAnalysisTemplate = CfnAnalysisTemplate.Builder.create(this, "MyCfnAnalysisTemplate") .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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Optional.static interface
A relation within an analysis.static interface
The structure that defines the body of the analysis template.static final class
A fluent builder forCfnAnalysisTemplate
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnAnalysisTemplate
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAnalysisTemplate
(software.amazon.jsii.JsiiObjectRef objRef) CfnAnalysisTemplate
(software.constructs.Construct scope, String id, CfnAnalysisTemplateProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe parameters of the analysis template.Returns the identifier for the analysis template.Returns the Amazon Resource Name (ARN) of the analysis template.Returns the unique ARN for the analysis template’s associated collaboration.Returns the unique ID for the associated collaboration of the analysis template.Returns the Amazon Resource Name (ARN) of the member who created the analysis template.Tag Manager which manages the tags for this resource.The description of the analysis template.The format of the analysis template.The identifier for a membership resource.getName()
The name of the analysis template.The source of the analysis template.getTags()
An optional label that you can assign to a resource when you create it.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAnalysisParameters
(List<Object> value) The parameters of the analysis template.void
setAnalysisParameters
(IResolvable value) The parameters of the analysis template.void
setDescription
(String value) The description of the analysis template.void
The format of the analysis template.void
setMembershipIdentifier
(String value) The identifier for a membership resource.void
The name of the analysis template.void
setSource
(IResolvable value) The source of the analysis template.void
The source of the analysis template.void
An optional label that you can assign to a resource when you create it.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAnalysisTemplate
protected CfnAnalysisTemplate(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAnalysisTemplate
protected CfnAnalysisTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAnalysisTemplate
@Stability(Stable) public CfnAnalysisTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnalysisTemplateProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAnalysisTemplateIdentifier
Returns the identifier for the analysis template.Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE2222
-
getAttrArn
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
-
getAttrCollaborationArn
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
-
getAttrCollaborationIdentifier
Returns the unique ID for the associated collaboration of the analysis template.Example:
a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
-
getAttrMembershipArn
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
-
getAttrSchema
-
getAttrSchemaReferencedTables
-
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getFormat
The format of the analysis template. -
setFormat
The format of the analysis template. -
getMembershipIdentifier
The identifier for a membership resource. -
setMembershipIdentifier
The identifier for a membership resource. -
getName
The name of the analysis template. -
setName
The name of the analysis template. -
getSource
The source of the analysis template. -
setSource
The source of the analysis template. -
setSource
The source of the analysis template. -
getAnalysisParameters
The parameters of the analysis template. -
setAnalysisParameters
The parameters of the analysis template. -
setAnalysisParameters
The parameters of the analysis template. -
getDescription
The description of the analysis template. -
setDescription
The description of the analysis template. -
getTags
An optional label that you can assign to a resource when you create it. -
setTags
An optional label that you can assign to a resource when you create it.
-