PolicyDetails.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`PolicyDetails.Builder`	`actions(Action... actions)` The actions to be performed when the event-based policy is triggered.
`PolicyDetails.Builder`	`actions(Collection<Action> actions)` The actions to be performed when the event-based policy is triggered.
`PolicyDetails.Builder`	`actions(Consumer<Action.Builder>... actions)` The actions to be performed when the event-based policy is triggered.
`default PolicyDetails.Builder`	`eventSource(Consumer<EventSource.Builder> eventSource)` The event that triggers the event-based policy.
`PolicyDetails.Builder`	`eventSource(EventSource eventSource)` The event that triggers the event-based policy.
`default PolicyDetails.Builder`	`parameters(Consumer<Parameters.Builder> parameters)` A set of optional parameters for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`parameters(Parameters parameters)` A set of optional parameters for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`policyType(PolicyTypeValues policyType)` The valid target resource types and actions a policy can manage.
`PolicyDetails.Builder`	`policyType(String policyType)` The valid target resource types and actions a policy can manage.
`PolicyDetails.Builder`	`resourceLocations(Collection<ResourceLocationValues> resourceLocations)` The location of the resources to backup.
`PolicyDetails.Builder`	`resourceLocations(ResourceLocationValues... resourceLocations)` The location of the resources to backup.
`PolicyDetails.Builder`	`resourceLocationsWithStrings(Collection<String> resourceLocations)` The location of the resources to backup.
`PolicyDetails.Builder`	`resourceLocationsWithStrings(String... resourceLocations)` The location of the resources to backup.
`PolicyDetails.Builder`	`resourceTypes(Collection<ResourceTypeValues> resourceTypes)` The target resource type for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`resourceTypes(ResourceTypeValues... resourceTypes)` The target resource type for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`resourceTypesWithStrings(Collection<String> resourceTypes)` The target resource type for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`resourceTypesWithStrings(String... resourceTypes)` The target resource type for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`schedules(Collection<Schedule> schedules)` The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`schedules(Consumer<Schedule.Builder>... schedules)` The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`schedules(Schedule... schedules)` The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
`PolicyDetails.Builder`	`targetTags(Collection<Tag> targetTags)` The single tag that identifies targeted resources for this policy.
`PolicyDetails.Builder`	`targetTags(Consumer<Tag.Builder>... targetTags)` The single tag that identifies targeted resources for this policy.
`PolicyDetails.Builder`	`targetTags(Tag... targetTags)` 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)
```
    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 - 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)
```
    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 - 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)
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    resourceTypes - 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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceTypesWithStrings
```
PolicyDetails.Builder resourceTypesWithStrings(String... resourceTypes)
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    resourceTypes - 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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceTypes
```
PolicyDetails.Builder resourceTypes(Collection<ResourceTypeValues> resourceTypes)
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    resourceTypes - 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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceTypes
```
PolicyDetails.Builder resourceTypes(ResourceTypeValues... resourceTypes)
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    resourceTypes - 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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - resourceLocationsWithStrings
```
PolicyDetails.Builder resourceLocationsWithStrings(Collection<String> resourceLocations)
```
    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 - 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)
```
    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 - 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)
```
    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 - 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)
```
    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 - 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)
```
    The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    targetTags - The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targetTags
```
PolicyDetails.Builder targetTags(Tag... targetTags)
```
    The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    targetTags - The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targetTags
```
PolicyDetails.Builder targetTags(Consumer<Tag.Builder>... targetTags)
```
    The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    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 #targetTags(List).
    
    Parameters:
    
    targetTags - 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:
    
    #targetTags(List)
  - schedules
```
PolicyDetails.Builder schedules(Collection<Schedule> schedules)
```
    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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    schedules - 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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedules
```
PolicyDetails.Builder schedules(Schedule... schedules)
```
    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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    schedules - 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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedules
```
PolicyDetails.Builder schedules(Consumer<Schedule.Builder>... schedules)
```
    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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    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 #schedules(List).
    
    Parameters:
    
    schedules - 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:
    
    #schedules(List)
  - parameters
```
PolicyDetails.Builder parameters(Parameters parameters)
```
    A set of optional parameters for snapshot and AMI lifecycle policies.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Parameters:
    
    parameters - A set of optional parameters for snapshot and AMI lifecycle policies.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
default PolicyDetails.Builder parameters(Consumer<Parameters.Builder> parameters)
```
    A set of optional parameters for snapshot and AMI lifecycle policies.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    This is a convenience 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)
```
    The event that triggers the event-based policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Parameters:
    
    eventSource - The event that triggers the event-based policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - eventSource
```
default PolicyDetails.Builder eventSource(Consumer<EventSource.Builder> eventSource)
```
    The event that triggers the event-based policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    This is a convenience 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)
```
    The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Parameters:
    
    actions - The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - actions
```
PolicyDetails.Builder actions(Action... actions)
```
    The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Parameters:
    
    actions - The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - actions
```
PolicyDetails.Builder actions(Consumer<Action.Builder>... actions)
```
    The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    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 #actions(List).
    
    Parameters:
    
    actions - 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:
    
    #actions(List)

Interface PolicyDetails.Builder

Method Summary

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

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

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

Method Detail

policyType

policyType

resourceTypesWithStrings

resourceTypesWithStrings

resourceTypes

resourceTypes

resourceLocationsWithStrings

resourceLocationsWithStrings

resourceLocations

resourceLocations

targetTags

targetTags

targetTags

schedules

schedules

schedules

parameters

parameters

eventSource

eventSource

actions

actions

actions