Package software.amazon.awscdk.services.cleanrooms

Interface CfnAnalysisTemplate.AnalysisParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisTemplate.AnalysisParameterProperty.Jsii$Proxy

Enclosing class:

CfnAnalysisTemplate

@Stability(Stable)
public static interface CfnAnalysisTemplate.AnalysisParameterProperty
extends software.amazon.jsii.JsiiSerializable

Optional.

The member who can query can provide this placeholder for a literal data value in an 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.*;
 AnalysisParameterProperty analysisParameterProperty = AnalysisParameterProperty.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .defaultValue("defaultValue")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysisTemplate.AnalysisParameterProperty.Builder	builder()
default String	getDefaultValue()	Optional.
String	getName()	The name of the parameter.
String	getType()	The type of parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the parameter.

The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-type

getDefaultValue

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

Optional.

The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue

builder

@Stability(Stable)
static CfnAnalysisTemplate.AnalysisParameterProperty.Builder builder()

Returns:

a CfnAnalysisTemplate.AnalysisParameterProperty.Builder of CfnAnalysisTemplate.AnalysisParameterProperty