Package software.amazon.awssdk.services.rbin.model

Interface UpdateRuleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateRuleRequest.Builder,UpdateRuleRequest>, RbinRequest.Builder, SdkBuilder<UpdateRuleRequest.Builder,UpdateRuleRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateRuleRequest

public static interface UpdateRuleRequest.Builder
extends RbinRequest.Builder, SdkPojo, CopyableBuilder<UpdateRuleRequest.Builder,UpdateRuleRequest>

Method Summary

Modifier and Type	Method	Description
UpdateRuleRequest.Builder	description(String description)	The retention rule description.
UpdateRuleRequest.Builder	excludeResourceTags(Collection<ResourceTag> excludeResourceTags)	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
UpdateRuleRequest.Builder	excludeResourceTags(Consumer<ResourceTag.Builder>... excludeResourceTags)	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
UpdateRuleRequest.Builder	excludeResourceTags(ResourceTag... excludeResourceTags)	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
UpdateRuleRequest.Builder	identifier(String identifier)	The unique ID of the retention rule.
UpdateRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateRuleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateRuleRequest.Builder	resourceTags(Collection<ResourceTag> resourceTags)	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
UpdateRuleRequest.Builder	resourceTags(Consumer<ResourceTag.Builder>... resourceTags)	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
UpdateRuleRequest.Builder	resourceTags(ResourceTag... resourceTags)	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
UpdateRuleRequest.Builder	resourceType(String resourceType)
UpdateRuleRequest.Builder	resourceType(ResourceType resourceType)
default UpdateRuleRequest.Builder	retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)	Information about the retention period for which the retention rule is to retain resources.
UpdateRuleRequest.Builder	retentionPeriod(RetentionPeriod retentionPeriod)	Information about the retention period for which the retention rule is to retain resources.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.rbin.model.RbinRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

identifier

UpdateRuleRequest.Builder identifier(String identifier)

The unique ID of the retention rule.

Parameters:

identifier - The unique ID of the retention rule.

Returns:

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

retentionPeriod

UpdateRuleRequest.Builder retentionPeriod(RetentionPeriod retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

Returns:

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

retentionPeriod

default UpdateRuleRequest.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

This is a convenience method that creates an instance of the RetentionPeriod.Builder avoiding the need to create one manually via RetentionPeriod.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retentionPeriod(RetentionPeriod).

Parameters:

retentionPeriod - a consumer that will call methods on RetentionPeriod.Builder

Returns:

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

See Also:

retentionPeriod(RetentionPeriod)

description

UpdateRuleRequest.Builder description(String description)

The retention rule description.

Parameters:

description - The retention rule description.

Returns:

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

resourceType

UpdateRuleRequest.Builder resourceType(String resourceType)

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Parameters:

resourceType -

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Returns:

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

See Also:

ResourceType, ResourceType

resourceType

UpdateRuleRequest.Builder resourceType(ResourceType resourceType)

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Parameters:

resourceType -

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

Returns:

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

See Also:

ResourceType, ResourceType

resourceTags

UpdateRuleRequest.Builder resourceTags(Collection<ResourceTag> resourceTags)

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:

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

resourceTags

UpdateRuleRequest.Builder resourceTags(ResourceTag... resourceTags)

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:

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

resourceTags

UpdateRuleRequest.Builder resourceTags(Consumer<ResourceTag.Builder>... resourceTags)

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

This is a convenience method that creates an instance of the ResourceTag.Builder avoiding the need to create one manually via ResourceTag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #resourceTags(List).

Parameters:

resourceTags - a consumer that will call methods on ResourceTag.Builder

Returns:

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

See Also:

#resourceTags(java.util.Collection)

excludeResourceTags

UpdateRuleRequest.Builder excludeResourceTags(Collection<ResourceTag> excludeResourceTags)

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Parameters:

excludeResourceTags - [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Returns:

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

excludeResourceTags

UpdateRuleRequest.Builder excludeResourceTags(ResourceTag... excludeResourceTags)

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Parameters:

excludeResourceTags - [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Returns:

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

excludeResourceTags

UpdateRuleRequest.Builder excludeResourceTags(Consumer<ResourceTag.Builder>... excludeResourceTags)

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

This is a convenience method that creates an instance of the ResourceTag.Builder avoiding the need to create one manually via ResourceTag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #excludeResourceTags(List).

Parameters:

excludeResourceTags - a consumer that will call methods on ResourceTag.Builder

Returns:

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

See Also:

#excludeResourceTags(java.util.Collection)

overrideConfiguration

UpdateRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder