software.amazon.awssdk.services.dlm.model

Interface PolicyDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PolicyDetails.Builder,PolicyDetails>, SdkBuilder<PolicyDetails.Builder,PolicyDetails>, SdkPojo

Enclosing class:

PolicyDetails

public static interface PolicyDetails.Builder
extends SdkPojo, CopyableBuilder<PolicyDetails.Builder,PolicyDetails>

Method Summary

Modifier and Type	Method and Description
PolicyDetails.Builder	actions(Action... actions) [Event-based policies only] The actions to be performed when the event-based policy is activated.
PolicyDetails.Builder	actions(Collection<Action> actions) [Event-based policies only] The actions to be performed when the event-based policy is activated.
PolicyDetails.Builder	actions(Consumer<Action.Builder>... actions) [Event-based policies only] The actions to be performed when the event-based policy is activated.
default PolicyDetails.Builder	eventSource(Consumer<EventSource.Builder> eventSource) [Event-based policies only] The event that activates the event-based policy.
PolicyDetails.Builder	eventSource(EventSource eventSource) [Event-based policies only] The event that activates the event-based policy.
default PolicyDetails.Builder	parameters(Consumer<Parameters.Builder> parameters) [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	parameters(Parameters parameters) [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	policyType(PolicyTypeValues policyType) [All policy types] The valid target resource types and actions a policy can manage.
PolicyDetails.Builder	policyType(String policyType) [All policy types] The valid target resource types and actions a policy can manage.
PolicyDetails.Builder	resourceLocations(Collection<ResourceLocationValues> resourceLocations) [Snapshot and AMI policies only] The location of the resources to backup.
PolicyDetails.Builder	resourceLocations(ResourceLocationValues... resourceLocations) [Snapshot and AMI policies only] The location of the resources to backup.
PolicyDetails.Builder	resourceLocationsWithStrings(Collection<String> resourceLocations) [Snapshot and AMI policies only] The location of the resources to backup.
PolicyDetails.Builder	resourceLocationsWithStrings(String... resourceLocations) [Snapshot and AMI policies only] The location of the resources to backup.
PolicyDetails.Builder	resourceTypes(Collection<ResourceTypeValues> resourceTypes) [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	resourceTypes(ResourceTypeValues... resourceTypes) [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	resourceTypesWithStrings(Collection<String> resourceTypes) [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	resourceTypesWithStrings(String... resourceTypes) [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	schedules(Collection<Schedule> schedules) [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	schedules(Consumer<Schedule.Builder>... schedules) [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	schedules(Schedule... schedules) [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
PolicyDetails.Builder	targetTags(Collection<Tag> targetTags) [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
PolicyDetails.Builder	targetTags(Consumer<Tag.Builder>... targetTags) [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
PolicyDetails.Builder	targetTags(Tag... targetTags) [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

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

policyType

PolicyDetails.Builder policyType(String policyType)

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

Parameters:

policyType - [All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

Returns:

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

See Also:

PolicyTypeValues, PolicyTypeValues

policyType

PolicyDetails.Builder policyType(PolicyTypeValues policyType)

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

Parameters:

policyType - [All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

Returns:

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

See Also:

PolicyTypeValues, PolicyTypeValues

resourceTypesWithStrings

PolicyDetails.Builder resourceTypesWithStrings(Collection<String> resourceTypes)

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Parameters:

resourceTypes - [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Returns:

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

resourceTypesWithStrings

PolicyDetails.Builder resourceTypesWithStrings(String... resourceTypes)

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Parameters:

resourceTypes - [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Returns:

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

resourceTypes

PolicyDetails.Builder resourceTypes(Collection<ResourceTypeValues> resourceTypes)

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Parameters:

resourceTypes - [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Returns:

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

resourceTypes

PolicyDetails.Builder resourceTypes(ResourceTypeValues... resourceTypes)

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Parameters:

resourceTypes - [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Returns:

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

resourceLocationsWithStrings

PolicyDetails.Builder resourceLocationsWithStrings(Collection<String> resourceLocations)

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Parameters:

resourceLocations - [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Returns:

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

resourceLocationsWithStrings

PolicyDetails.Builder resourceLocationsWithStrings(String... resourceLocations)

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Parameters:

resourceLocations - [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Returns:

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

resourceLocations

PolicyDetails.Builder resourceLocations(Collection<ResourceLocationValues> resourceLocations)

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Parameters:

resourceLocations - [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Returns:

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

resourceLocations

PolicyDetails.Builder resourceLocations(ResourceLocationValues... resourceLocations)

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Parameters:

resourceLocations - [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Returns:

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

targetTags

PolicyDetails.Builder targetTags(Collection<Tag> targetTags)

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Parameters:

targetTags - [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Returns:

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

targetTags

PolicyDetails.Builder targetTags(Tag... targetTags)

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Parameters:

targetTags - [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Returns:

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

targetTags

PolicyDetails.Builder targetTags(Consumer<Tag.Builder>... targetTags)

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

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

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

Parameters:

targetTags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#targetTags(java.util.Collection)

schedules

PolicyDetails.Builder schedules(Collection<Schedule> schedules)

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

Parameters:

schedules - [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

Returns:

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

schedules

PolicyDetails.Builder schedules(Schedule... schedules)

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

Parameters:

schedules - [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

Returns:

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

schedules

PolicyDetails.Builder schedules(Consumer<Schedule.Builder>... schedules)

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

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

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

Parameters:

schedules - a consumer that will call methods on Schedule.Builder

Returns:

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

See Also:

#schedules(java.util.Collection)

parameters

PolicyDetails.Builder parameters(Parameters parameters)

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

Parameters:

parameters - [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

Returns:

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

parameters

default PolicyDetails.Builder parameters(Consumer<Parameters.Builder> parameters)

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

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

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

Parameters:

parameters - a consumer that will call methods on Parameters.Builder

Returns:

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

See Also:

parameters(Parameters)

eventSource

PolicyDetails.Builder eventSource(EventSource eventSource)

[Event-based policies only] The event that activates the event-based policy.

Parameters:

eventSource - [Event-based policies only] The event that activates the event-based policy.

Returns:

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

eventSource

default PolicyDetails.Builder eventSource(Consumer<EventSource.Builder> eventSource)

[Event-based policies only] The event that activates the event-based policy.

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

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

Parameters:

eventSource - a consumer that will call methods on EventSource.Builder

Returns:

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

See Also:

eventSource(EventSource)

actions

PolicyDetails.Builder actions(Collection<Action> actions)

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

Parameters:

actions - [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

Returns:

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

actions

PolicyDetails.Builder actions(Action... actions)

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

Parameters:

actions - [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

Returns:

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

actions

PolicyDetails.Builder actions(Consumer<Action.Builder>... actions)

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

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

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

Parameters:

actions - a consumer that will call methods on Action.Builder

Returns:

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

See Also:

#actions(java.util.Collection)