io.cloudshiftdev.awscdk.services.greengrass.CfnCoreDefinitionProps.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 `CfnCoreDefinition`.
*
* 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;
* CfnCoreDefinitionProps cfnCoreDefinitionProps = CfnCoreDefinitionProps.builder()
* .name("name")
* // the properties below are optional
* .initialVersion(CoreDefinitionVersionProperty.builder()
* .cores(List.of(CoreProperty.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-coredefinition.html)
*/
public interface CfnCoreDefinitionProps {
/**
* The core definition version to include when the core definition is created.
*
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion)
*/
public fun initialVersion(): Any? = unwrap(this).getInitialVersion()
/**
* The name of the core definition.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name)
*/
public fun name(): String
/**
* Application-specific metadata to attach to the core 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-coredefinition.html#cfn-greengrass-coredefinition-tags)
*/
public fun tags(): Any? = unwrap(this).getTags()
/**
* A builder for [CfnCoreDefinitionProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
public fun initialVersion(initialVersion: IResolvable)
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
public fun initialVersion(initialVersion: CfnCoreDefinition.CoreDefinitionVersionProperty)
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("155f1a16580ddc36d6af0cc36c4e39d53b5d76f362fa2470895bc3c456d6e784")
public
fun initialVersion(initialVersion: CfnCoreDefinition.CoreDefinitionVersionProperty.Builder.() -> Unit)
/**
* @param name The name of the core definition.
*/
public fun name(name: String)
/**
* @param tags Application-specific metadata to attach to the core 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.CfnCoreDefinitionProps.Builder =
software.amazon.awscdk.services.greengrass.CfnCoreDefinitionProps.builder()
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
override fun initialVersion(initialVersion: IResolvable) {
cdkBuilder.initialVersion(initialVersion.let(IResolvable.Companion::unwrap))
}
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
override fun initialVersion(initialVersion: CfnCoreDefinition.CoreDefinitionVersionProperty) {
cdkBuilder.initialVersion(initialVersion.let(CfnCoreDefinition.CoreDefinitionVersionProperty.Companion::unwrap))
}
/**
* @param initialVersion The core definition version to include when the core definition is
* created.
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("155f1a16580ddc36d6af0cc36c4e39d53b5d76f362fa2470895bc3c456d6e784")
override
fun initialVersion(initialVersion: CfnCoreDefinition.CoreDefinitionVersionProperty.Builder.() -> Unit):
Unit = initialVersion(CfnCoreDefinition.CoreDefinitionVersionProperty(initialVersion))
/**
* @param name The name of the core definition.
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param tags Application-specific metadata to attach to the core 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.CfnCoreDefinitionProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.greengrass.CfnCoreDefinitionProps,
) : CdkObject(cdkObject),
CfnCoreDefinitionProps {
/**
* The core definition version to include when the core definition is created.
*
* Currently, a core definition version can contain only one
* [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html)
* .
*
*
* To associate a core definition version after the core definition is created, create an
* [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html)
* resource and specify the ID of this core definition.
*
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-initialversion)
*/
override fun initialVersion(): Any? = unwrap(this).getInitialVersion()
/**
* The name of the core definition.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinition.html#cfn-greengrass-coredefinition-name)
*/
override fun name(): String = unwrap(this).getName()
/**
* Application-specific metadata to attach to the core 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-coredefinition.html#cfn-greengrass-coredefinition-tags)
*/
override fun tags(): Any? = unwrap(this).getTags()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnCoreDefinitionProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.greengrass.CfnCoreDefinitionProps):
CfnCoreDefinitionProps = CdkObjectWrappers.wrap(cdkObject) as? CfnCoreDefinitionProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnCoreDefinitionProps):
software.amazon.awscdk.services.greengrass.CfnCoreDefinitionProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.greengrass.CfnCoreDefinitionProps
}
}