Skip to content
v2.277.0

VariableProperty Struct ​

An instance of a variable to be passed to the containerAction execution.

Each variable must have a name and a value given by one of stringValue , datasetContentVersionValue , or outputFileUriValue .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';
const variableProperty: iotanalytics.CfnDataset.VariableProperty = {
  variableName: 'variableName',

  // the properties below are optional
  datasetContentVersionValue: {
    datasetName: 'datasetName',
  },
  doubleValue: 123,
  outputFileUriValue: {
    fileName: 'fileName',
  },
  stringValue: 'stringValue',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotanalytics as iotanalytics

variable_property = iotanalytics.CfnDataset.VariableProperty(
    variable_name="variableName",

    # the properties below are optional
    dataset_content_version_value=iotanalytics.CfnDataset.DatasetContentVersionValueProperty(
        dataset_name="datasetName"
    ),
    double_value=123,
    output_file_uri_value=iotanalytics.CfnDataset.OutputFileUriValueProperty(
        file_name="fileName"
    ),
    string_value="stringValue"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iotanalytics.*;

VariableProperty variableProperty = VariableProperty.builder()
        .variableName("variableName")

        // the properties below are optional
        .datasetContentVersionValue(DatasetContentVersionValueProperty.builder()
                .datasetName("datasetName")
                .build())
        .doubleValue(123)
        .outputFileUriValue(OutputFileUriValueProperty.builder()
                .fileName("fileName")
                .build())
        .stringValue("stringValue")
        .build();
csharp
// 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.IoTAnalytics;

var variableProperty = new VariableProperty {
    VariableName = "variableName",

    // the properties below are optional
    DatasetContentVersionValue = new DatasetContentVersionValueProperty {
        DatasetName = "datasetName"
    },
    DoubleValue = 123,
    OutputFileUriValue = new OutputFileUriValueProperty {
        FileName = "fileName"
    },
    StringValue = "stringValue"
};
go
// 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"

variableProperty := &VariableProperty{
	VariableName: jsii.String("variableName"),

	// the properties below are optional
	DatasetContentVersionValue: &DatasetContentVersionValueProperty{
		DatasetName: jsii.String("datasetName"),
	},
	DoubleValue: jsii.Number(123),
	OutputFileUriValue: &OutputFileUriValueProperty{
		FileName: jsii.String("fileName"),
	},
	StringValue: jsii.String("stringValue"),
}

Properties ​

datasetContentVersionValueoptionalIResolvable | CfnDataset.DatasetContentVersionValuePropertydataset_content_version_valueoptionaltyping.Union[IResolvable, DatasetContentVersionValueProperty]datasetContentVersionValueoptionalIResolvableDatasetContentVersionValueoptionalIResolvableDatasetContentVersionValueoptionalinterface{}#
The value of the variable as a structure that specifies a dataset content version.
doubleValueoptionalnumberdouble_valueoptionalint | floatdoubleValueoptionalNumberDoubleValueoptionaldoubleDoubleValueoptional*float64#
The value of the variable as a double (numeric).
outputFileUriValueoptionalIResolvable | CfnDataset.OutputFileUriValuePropertyoutput_file_uri_valueoptionaltyping.Union[IResolvable, OutputFileUriValueProperty]outputFileUriValueoptionalIResolvableOutputFileUriValueoptionalIResolvableOutputFileUriValueoptionalinterface{}#
The value of the variable as a structure that specifies an output file URI.
stringValueoptionalstringstring_valueoptionalstrstringValueoptionalStringStringValueoptionalstringStringValueoptional*string#
The value of the variable as a string.
variableNamestringvariable_namestrvariableNameStringVariableNamestringVariableName*stringrequired#
The name of the variable.