aws-cdk-lib.aws_quicksight.CfnTemplate.StringParameterDeclarationProperty

StringParameterDeclarationProperty Struct

A parameter declaration for the String data type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const stringParameterDeclarationProperty: quicksight.CfnTemplate.StringParameterDeclarationProperty = {
  name: 'name',
  parameterValueType: 'parameterValueType',

  // the properties below are optional
  defaultValues: {
    dynamicValue: {
      defaultValueColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },

      // the properties below are optional
      groupNameColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
      userNameColumn: {
        columnName: 'columnName',

        // the properties below are optional
        dataSetIdentifier: 'dataSetIdentifier',
        topicIdentifier: 'topicIdentifier',
      },
    },
    staticValues: ['staticValues'],
  },
  mappedDataSetParameters: [{
    dataSetIdentifier: 'dataSetIdentifier',
    dataSetParameterName: 'dataSetParameterName',
  }],
  valueWhenUnset: {
    customValue: 'customValue',
    valueWhenUnsetOption: 'valueWhenUnsetOption',
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

string_parameter_declaration_property = quicksight.CfnTemplate.StringParameterDeclarationProperty(
    name="name",
    parameter_value_type="parameterValueType",

    # the properties below are optional
    default_values=quicksight.CfnTemplate.StringDefaultValuesProperty(
        dynamic_value=quicksight.CfnTemplate.DynamicDefaultValueProperty(
            default_value_column=quicksight.CfnTemplate.ColumnIdentifierProperty(
                column_name="columnName",

                # the properties below are optional
                data_set_identifier="dataSetIdentifier",
                topic_identifier="topicIdentifier"
            ),

            # the properties below are optional
            group_name_column=quicksight.CfnTemplate.ColumnIdentifierProperty(
                column_name="columnName",

                # the properties below are optional
                data_set_identifier="dataSetIdentifier",
                topic_identifier="topicIdentifier"
            ),
            user_name_column=quicksight.CfnTemplate.ColumnIdentifierProperty(
                column_name="columnName",

                # the properties below are optional
                data_set_identifier="dataSetIdentifier",
                topic_identifier="topicIdentifier"
            )
        ),
        static_values=["staticValues"]
    ),
    mapped_data_set_parameters=[quicksight.CfnTemplate.MappedDataSetParameterProperty(
        data_set_identifier="dataSetIdentifier",
        data_set_parameter_name="dataSetParameterName"
    )],
    value_when_unset=quicksight.CfnTemplate.StringValueWhenUnsetConfigurationProperty(
        custom_value="customValue",
        value_when_unset_option="valueWhenUnsetOption"
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

StringParameterDeclarationProperty stringParameterDeclarationProperty = StringParameterDeclarationProperty.builder()
        .name("name")
        .parameterValueType("parameterValueType")

        // the properties below are optional
        .defaultValues(StringDefaultValuesProperty.builder()
                .dynamicValue(DynamicDefaultValueProperty.builder()
                        .defaultValueColumn(ColumnIdentifierProperty.builder()
                                .columnName("columnName")

                                // the properties below are optional
                                .dataSetIdentifier("dataSetIdentifier")
                                .topicIdentifier("topicIdentifier")
                                .build())

                        // the properties below are optional
                        .groupNameColumn(ColumnIdentifierProperty.builder()
                                .columnName("columnName")

                                // the properties below are optional
                                .dataSetIdentifier("dataSetIdentifier")
                                .topicIdentifier("topicIdentifier")
                                .build())
                        .userNameColumn(ColumnIdentifierProperty.builder()
                                .columnName("columnName")

                                // the properties below are optional
                                .dataSetIdentifier("dataSetIdentifier")
                                .topicIdentifier("topicIdentifier")
                                .build())
                        .build())
                .staticValues(List.of("staticValues"))
                .build())
        .mappedDataSetParameters(List.of(MappedDataSetParameterProperty.builder()
                .dataSetIdentifier("dataSetIdentifier")
                .dataSetParameterName("dataSetParameterName")
                .build()))
        .valueWhenUnset(StringValueWhenUnsetConfigurationProperty.builder()
                .customValue("customValue")
                .valueWhenUnsetOption("valueWhenUnsetOption")
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var stringParameterDeclarationProperty = new StringParameterDeclarationProperty {
    Name = "name",
    ParameterValueType = "parameterValueType",

    // the properties below are optional
    DefaultValues = new StringDefaultValuesProperty {
        DynamicValue = new DynamicDefaultValueProperty {
            DefaultValueColumn = new ColumnIdentifierProperty {
                ColumnName = "columnName",

                // the properties below are optional
                DataSetIdentifier = "dataSetIdentifier",
                TopicIdentifier = "topicIdentifier"
            },

            // the properties below are optional
            GroupNameColumn = new ColumnIdentifierProperty {
                ColumnName = "columnName",

                // the properties below are optional
                DataSetIdentifier = "dataSetIdentifier",
                TopicIdentifier = "topicIdentifier"
            },
            UserNameColumn = new ColumnIdentifierProperty {
                ColumnName = "columnName",

                // the properties below are optional
                DataSetIdentifier = "dataSetIdentifier",
                TopicIdentifier = "topicIdentifier"
            }
        },
        StaticValues = new [] { "staticValues" }
    },
    MappedDataSetParameters = new [] { new MappedDataSetParameterProperty {
        DataSetIdentifier = "dataSetIdentifier",
        DataSetParameterName = "dataSetParameterName"
    } },
    ValueWhenUnset = new StringValueWhenUnsetConfigurationProperty {
        CustomValue = "customValue",
        ValueWhenUnsetOption = "valueWhenUnsetOption"
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

stringParameterDeclarationProperty := &StringParameterDeclarationProperty{
	Name: jsii.String("name"),
	ParameterValueType: jsii.String("parameterValueType"),

	// the properties below are optional
	DefaultValues: &StringDefaultValuesProperty{
		DynamicValue: &DynamicDefaultValueProperty{
			DefaultValueColumn: &ColumnIdentifierProperty{
				ColumnName: jsii.String("columnName"),

				// the properties below are optional
				DataSetIdentifier: jsii.String("dataSetIdentifier"),
				TopicIdentifier: jsii.String("topicIdentifier"),
			},

			// the properties below are optional
			GroupNameColumn: &ColumnIdentifierProperty{
				ColumnName: jsii.String("columnName"),

				// the properties below are optional
				DataSetIdentifier: jsii.String("dataSetIdentifier"),
				TopicIdentifier: jsii.String("topicIdentifier"),
			},
			UserNameColumn: &ColumnIdentifierProperty{
				ColumnName: jsii.String("columnName"),

				// the properties below are optional
				DataSetIdentifier: jsii.String("dataSetIdentifier"),
				TopicIdentifier: jsii.String("topicIdentifier"),
			},
		},
		StaticValues: []*string{
			jsii.String("staticValues"),
		},
	},
	MappedDataSetParameters: []interface{}{
		&MappedDataSetParameterProperty{
			DataSetIdentifier: jsii.String("dataSetIdentifier"),
			DataSetParameterName: jsii.String("dataSetParameterName"),
		},
	},
	ValueWhenUnset: &StringValueWhenUnsetConfigurationProperty{
		CustomValue: jsii.String("customValue"),
		ValueWhenUnsetOption: jsii.String("valueWhenUnsetOption"),
	},
}

Properties

defaultValues?optionalIResolvable | CfnTemplate.StringDefaultValuesPropertydefault_values?optionaltyping.Union[IResolvable, StringDefaultValuesProperty]defaultValues?optionalIResolvableDefaultValues?optionalIResolvableDefaultValues?optionalinterface{}#

The default values of a parameter.

If the parameter is a single-value parameter, a maximum of one default value can be provided.

mappedDataSetParameters?optionalIResolvable | IResolvable | CfnTemplate.MappedDataSetParameterProperty[]mapped_data_set_parameters?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MappedDataSetParameterProperty]]]mappedDataSetParameters?optionalIResolvableMappedDataSetParameters?optionalIResolvableMappedDataSetParameters?optionalinterface{}#

namestringnamestrnameStringNamestringName*stringrequired#

The name of the parameter that is being declared.

parameterValueTypestringparameter_value_typestrparameterValueTypeStringParameterValueTypestringParameterValueType*stringrequired#

The value type determines whether the parameter is a single-value or multi-value parameter.

valueWhenUnset?optionalIResolvable | CfnTemplate.StringValueWhenUnsetConfigurationPropertyvalue_when_unset?optionaltyping.Union[IResolvable, StringValueWhenUnsetConfigurationProperty]valueWhenUnset?optionalIResolvableValueWhenUnset?optionalIResolvableValueWhenUnset?optionalinterface{}#

The configuration that defines the default value of a `String` parameter when a value has not been set.