io.cloudshiftdev.awscdk.services.greengrass.CfnDeviceDefinitionProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.greengrass
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.jvm.JvmName
/**
* Properties for defining a `CfnDeviceDefinition`.
*
* 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.greengrass.*;
* Object tags;
* CfnDeviceDefinitionProps cfnDeviceDefinitionProps = CfnDeviceDefinitionProps.builder()
* .name("name")
* // the properties below are optional
* .initialVersion(DeviceDefinitionVersionProperty.builder()
* .devices(List.of(DeviceProperty.builder()
* .certificateArn("certificateArn")
* .id("id")
* .thingArn("thingArn")
* // the properties below are optional
* .syncShadow(false)
* .build()))
* .build())
* .tags(tags)
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html)
*/
public interface CfnDeviceDefinitionProps {
/**
* The device definition version to include when the device definition is created.
*
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion)
*/
public fun initialVersion(): Any? = unwrap(this).getInitialVersion()
/**
* The name of the device definition.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name)
*/
public fun name(): String
/**
* Application-specific metadata to attach to the device definition.
*
* You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can
* also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT
* Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in
* the *Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following
* format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags)
*/
public fun tags(): Any? = unwrap(this).getTags()
/**
* A builder for [CfnDeviceDefinitionProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
public fun initialVersion(initialVersion: IResolvable)
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
public fun initialVersion(initialVersion: CfnDeviceDefinition.DeviceDefinitionVersionProperty)
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("690c75c6a9437be0336307fb32c291d442d815e8129c1b3591914fe10e4c2233")
public
fun initialVersion(initialVersion: CfnDeviceDefinition.DeviceDefinitionVersionProperty.Builder.() -> Unit)
/**
* @param name The name of the device definition.
*/
public fun name(name: String)
/**
* @param tags Application-specific metadata to attach to the device definition.
* You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can
* also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT
* Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in
* the *Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following
* format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*/
public fun tags(tags: Any)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps.Builder =
software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps.builder()
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
override fun initialVersion(initialVersion: IResolvable) {
cdkBuilder.initialVersion(initialVersion.let(IResolvable.Companion::unwrap))
}
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
override
fun initialVersion(initialVersion: CfnDeviceDefinition.DeviceDefinitionVersionProperty) {
cdkBuilder.initialVersion(initialVersion.let(CfnDeviceDefinition.DeviceDefinitionVersionProperty.Companion::unwrap))
}
/**
* @param initialVersion The device definition version to include when the device definition is
* created.
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("690c75c6a9437be0336307fb32c291d442d815e8129c1b3591914fe10e4c2233")
override
fun initialVersion(initialVersion: CfnDeviceDefinition.DeviceDefinitionVersionProperty.Builder.() -> Unit):
Unit = initialVersion(CfnDeviceDefinition.DeviceDefinitionVersionProperty(initialVersion))
/**
* @param name The name of the device definition.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param tags Application-specific metadata to attach to the device definition.
* You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can
* also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT
* Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in
* the *Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following
* format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*/
override fun tags(tags: Any) {
cdkBuilder.tags(tags)
}
public fun build(): software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps,
) : CdkObject(cdkObject),
CfnDeviceDefinitionProps {
/**
* The device definition version to include when the device definition is created.
*
* A device definition version contains a list of
* [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html)
* property types.
*
*
* To associate a device definition version after the device definition is created, create an
* [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html)
* resource and specify the ID of this device definition.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-initialversion)
*/
override fun initialVersion(): Any? = unwrap(this).getInitialVersion()
/**
* The name of the device definition.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-name)
*/
override fun name(): String = unwrap(this).getName()
/**
* Application-specific metadata to attach to the device definition.
*
* You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can
* also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT
* Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in
* the *Developer Guide* .
*
* This `Json` property type is processed as a map of key-value pairs. It uses the following
* format, which is different from most `Tags` implementations in AWS CloudFormation templates.
*
* ```
* "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
* }
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinition.html#cfn-greengrass-devicedefinition-tags)
*/
override fun tags(): Any? = unwrap(this).getTags()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnDeviceDefinitionProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps):
CfnDeviceDefinitionProps = CdkObjectWrappers.wrap(cdkObject) as? CfnDeviceDefinitionProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnDeviceDefinitionProps):
software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.greengrass.CfnDeviceDefinitionProps
}
}