io.cloudshiftdev.awscdk.services.iotanalytics.CfnPipelineProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.iotanalytics
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
/**
* Properties for defining a `CfnPipeline`.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.iotanalytics.*;
* CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
* .pipelineActivities(List.of(ActivityProperty.builder()
* .addAttributes(AddAttributesProperty.builder()
* .attributes(Map.of(
* "attributesKey", "attributes"))
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .channel(ChannelProperty.builder()
* .channelName("channelName")
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .datastore(DatastoreProperty.builder()
* .datastoreName("datastoreName")
* .name("name")
* .build())
* .deviceRegistryEnrich(DeviceRegistryEnrichProperty.builder()
* .attribute("attribute")
* .name("name")
* .roleArn("roleArn")
* .thingName("thingName")
* // the properties below are optional
* .next("next")
* .build())
* .deviceShadowEnrich(DeviceShadowEnrichProperty.builder()
* .attribute("attribute")
* .name("name")
* .roleArn("roleArn")
* .thingName("thingName")
* // the properties below are optional
* .next("next")
* .build())
* .filter(FilterProperty.builder()
* .filter("filter")
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .lambda(LambdaProperty.builder()
* .batchSize(123)
* .lambdaName("lambdaName")
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .math(MathProperty.builder()
* .attribute("attribute")
* .math("math")
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .removeAttributes(RemoveAttributesProperty.builder()
* .attributes(List.of("attributes"))
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .selectAttributes(SelectAttributesProperty.builder()
* .attributes(List.of("attributes"))
* .name("name")
* // the properties below are optional
* .next("next")
* .build())
* .build()))
* // the properties below are optional
* .pipelineName("pipelineName")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html)
*/
public interface CfnPipelineProps {
/**
* A list of "PipelineActivity" objects.
*
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelineactivities)
*/
public fun pipelineActivities(): Any
/**
* The name of the pipeline.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelinename)
*/
public fun pipelineName(): String? = unwrap(this).getPipelineName()
/**
* Metadata which can be used to manage the pipeline.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* A builder for [CfnPipelineProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
public fun pipelineActivities(pipelineActivities: IResolvable)
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
public fun pipelineActivities(pipelineActivities: List)
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
public fun pipelineActivities(vararg pipelineActivities: Any)
/**
* @param pipelineName The name of the pipeline.
*/
public fun pipelineName(pipelineName: String)
/**
* @param tags Metadata which can be used to manage the pipeline.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
public fun tags(tags: List)
/**
* @param tags Metadata which can be used to manage the pipeline.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.iotanalytics.CfnPipelineProps.Builder =
software.amazon.awscdk.services.iotanalytics.CfnPipelineProps.builder()
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
override fun pipelineActivities(pipelineActivities: IResolvable) {
cdkBuilder.pipelineActivities(pipelineActivities.let(IResolvable.Companion::unwrap))
}
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
override fun pipelineActivities(pipelineActivities: List) {
cdkBuilder.pipelineActivities(pipelineActivities.map{CdkObjectWrappers.unwrap(it)})
}
/**
* @param pipelineActivities A list of "PipelineActivity" objects.
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*/
override fun pipelineActivities(vararg pipelineActivities: Any): Unit =
pipelineActivities(pipelineActivities.toList())
/**
* @param pipelineName The name of the pipeline.
*/
override fun pipelineName(pipelineName: String) {
cdkBuilder.pipelineName(pipelineName)
}
/**
* @param tags Metadata which can be used to manage the pipeline.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags Metadata which can be used to manage the pipeline.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.iotanalytics.CfnPipelineProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.iotanalytics.CfnPipelineProps,
) : CdkObject(cdkObject),
CfnPipelineProps {
/**
* A list of "PipelineActivity" objects.
*
* Activities perform transformations on your messages, such as removing, renaming or adding
* message attributes; filtering messages based on attribute values; invoking your Lambda functions
* on messages for advanced processing; or performing mathematical transformations to normalize
* device data.
*
* The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a
* `datastore` activity. Each entry in the list must contain only one activity, for example:
*
* `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelineactivities)
*/
override fun pipelineActivities(): Any = unwrap(this).getPipelineActivities()
/**
* The name of the pipeline.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelinename)
*/
override fun pipelineName(): String? = unwrap(this).getPipelineName()
/**
* Metadata which can be used to manage the pipeline.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnPipelineProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.iotanalytics.CfnPipelineProps):
CfnPipelineProps = CdkObjectWrappers.wrap(cdkObject) as? CfnPipelineProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnPipelineProps):
software.amazon.awscdk.services.iotanalytics.CfnPipelineProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.iotanalytics.CfnPipelineProps
}
}