software.amazon.awssdk.services.iot.model

Interface CreatePolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>, IotRequest.Builder, SdkBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreatePolicyRequest

public static interface CreatePolicyRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

Method Summary

Modifier and Type	Method and Description
CreatePolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreatePolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreatePolicyRequest.Builder	policyDocument(String policyDocument) The JSON document that describes the policy.
CreatePolicyRequest.Builder	policyName(String policyName) The policy name.
CreatePolicyRequest.Builder	tags(Collection<Tag> tags) Metadata which can be used to manage the policy.
CreatePolicyRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata which can be used to manage the policy.
CreatePolicyRequest.Builder	tags(Tag... tags) Metadata which can be used to manage the policy.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

policyName

CreatePolicyRequest.Builder policyName(String policyName)

The policy name.

Parameters:

policyName - The policy name.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyDocument

CreatePolicyRequest.Builder policyDocument(String policyDocument)

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Parameters:

policyDocument - The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreatePolicyRequest.Builder tags(Collection<Tag> tags)

Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags - Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreatePolicyRequest.Builder tags(Tag... tags)

Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags - Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreatePolicyRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

overrideConfiguration

CreatePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreatePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.