Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnProvisioningTemplatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnProvisioningTemplatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProvisioningTemplatePropsMixin>

Enclosing class:

CfnProvisioningTemplatePropsMixin

@Stability(Stable)
public static final class CfnProvisioningTemplatePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProvisioningTemplatePropsMixin>

A fluent builder for CfnProvisioningTemplatePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnProvisioningTemplatePropsMixin	build()
static CfnProvisioningTemplatePropsMixin.Builder	create()
static CfnProvisioningTemplatePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnProvisioningTemplatePropsMixin.Builder	description(String description)	The description of the fleet provisioning template.
CfnProvisioningTemplatePropsMixin.Builder	enabled(Boolean enabled)	True to enable the fleet provisioning template, otherwise false.
CfnProvisioningTemplatePropsMixin.Builder	enabled(IResolvable enabled)	True to enable the fleet provisioning template, otherwise false.
CfnProvisioningTemplatePropsMixin.Builder	preProvisioningHook(CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty preProvisioningHook)	Creates a pre-provisioning hook template.
CfnProvisioningTemplatePropsMixin.Builder	preProvisioningHook(IResolvable preProvisioningHook)	Creates a pre-provisioning hook template.
CfnProvisioningTemplatePropsMixin.Builder	provisioningRoleArn(String provisioningRoleArn)	The role ARN for the role associated with the fleet provisioning template.
CfnProvisioningTemplatePropsMixin.Builder	provisioningRoleArn(IRoleRef provisioningRoleArn)	The role ARN for the role associated with the fleet provisioning template.
CfnProvisioningTemplatePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Metadata that can be used to manage the fleet provisioning template.
CfnProvisioningTemplatePropsMixin.Builder	templateBody(String templateBody)	The JSON formatted contents of the fleet provisioning template version.
CfnProvisioningTemplatePropsMixin.Builder	templateName(String templateName)	The name of the fleet provisioning template.
CfnProvisioningTemplatePropsMixin.Builder	templateType(String templateType)	The type of the provisioning template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnProvisioningTemplatePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnProvisioningTemplatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnProvisioningTemplatePropsMixin.Builder create()

Returns:

a new instance of CfnProvisioningTemplatePropsMixin.Builder.

description

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder description(String description)

The description of the fleet provisioning template.

Parameters:

description - The description of the fleet provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-description

enabled

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder enabled(Boolean enabled)

True to enable the fleet provisioning template, otherwise false.

Parameters:

enabled - True to enable the fleet provisioning template, otherwise false. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-enabled

enabled

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder enabled(IResolvable enabled)

True to enable the fleet provisioning template, otherwise false.

Parameters:

enabled - True to enable the fleet provisioning template, otherwise false. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-enabled

preProvisioningHook

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder preProvisioningHook(IResolvable preProvisioningHook)

Creates a pre-provisioning hook template.

Parameters:

preProvisioningHook - Creates a pre-provisioning hook template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-preprovisioninghook

preProvisioningHook

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder preProvisioningHook(CfnProvisioningTemplatePropsMixin.ProvisioningHookProperty preProvisioningHook)

Creates a pre-provisioning hook template.

Parameters:

preProvisioningHook - Creates a pre-provisioning hook template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-preprovisioninghook

provisioningRoleArn

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder provisioningRoleArn(String provisioningRoleArn)

The role ARN for the role associated with the fleet provisioning template.

This IoT role grants permission to provision a device.

Parameters:

provisioningRoleArn - The role ARN for the role associated with the fleet provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-provisioningrolearn

provisioningRoleArn

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder provisioningRoleArn(IRoleRef provisioningRoleArn)

The role ARN for the role associated with the fleet provisioning template.

This IoT role grants permission to provision a device.

Parameters:

provisioningRoleArn - The role ARN for the role associated with the fleet provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-provisioningrolearn

tags

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder tags(List<? extends CfnTag> tags)

Metadata that can be used to manage the fleet provisioning template.

Parameters:

tags - Metadata that can be used to manage the fleet provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-tags

templateBody

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder templateBody(String templateBody)

The JSON formatted contents of the fleet provisioning template version.

Parameters:

templateBody - The JSON formatted contents of the fleet provisioning template version. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatebody

templateName

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder templateName(String templateName)

The name of the fleet provisioning template.

Parameters:

templateName - The name of the fleet provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatename

templateType

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin.Builder templateType(String templateType)

The type of the provisioning template.

Parameters:

templateType - The type of the provisioning template. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-templatetype

build

@Stability(Stable)
public CfnProvisioningTemplatePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnProvisioningTemplatePropsMixin>

Returns:

a newly built instance of CfnProvisioningTemplatePropsMixin.