AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::DLM::Model::PolicyDetails Class Reference

#include <PolicyDetails.h>

Public Member Functions

 PolicyDetails ()
 
 PolicyDetails (Aws::Utils::Json::JsonView jsonValue)
 
PolicyDetailsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const PolicyTypeValuesGetPolicyType () const
 
bool PolicyTypeHasBeenSet () const
 
void SetPolicyType (const PolicyTypeValues &value)
 
void SetPolicyType (PolicyTypeValues &&value)
 
PolicyDetailsWithPolicyType (const PolicyTypeValues &value)
 
PolicyDetailsWithPolicyType (PolicyTypeValues &&value)
 
const Aws::Vector< ResourceTypeValues > & GetResourceTypes () const
 
bool ResourceTypesHasBeenSet () const
 
void SetResourceTypes (const Aws::Vector< ResourceTypeValues > &value)
 
void SetResourceTypes (Aws::Vector< ResourceTypeValues > &&value)
 
PolicyDetailsWithResourceTypes (const Aws::Vector< ResourceTypeValues > &value)
 
PolicyDetailsWithResourceTypes (Aws::Vector< ResourceTypeValues > &&value)
 
PolicyDetailsAddResourceTypes (const ResourceTypeValues &value)
 
PolicyDetailsAddResourceTypes (ResourceTypeValues &&value)
 
const Aws::Vector< ResourceLocationValues > & GetResourceLocations () const
 
bool ResourceLocationsHasBeenSet () const
 
void SetResourceLocations (const Aws::Vector< ResourceLocationValues > &value)
 
void SetResourceLocations (Aws::Vector< ResourceLocationValues > &&value)
 
PolicyDetailsWithResourceLocations (const Aws::Vector< ResourceLocationValues > &value)
 
PolicyDetailsWithResourceLocations (Aws::Vector< ResourceLocationValues > &&value)
 
PolicyDetailsAddResourceLocations (const ResourceLocationValues &value)
 
PolicyDetailsAddResourceLocations (ResourceLocationValues &&value)
 
const Aws::Vector< Tag > & GetTargetTags () const
 
bool TargetTagsHasBeenSet () const
 
void SetTargetTags (const Aws::Vector< Tag > &value)
 
void SetTargetTags (Aws::Vector< Tag > &&value)
 
PolicyDetailsWithTargetTags (const Aws::Vector< Tag > &value)
 
PolicyDetailsWithTargetTags (Aws::Vector< Tag > &&value)
 
PolicyDetailsAddTargetTags (const Tag &value)
 
PolicyDetailsAddTargetTags (Tag &&value)
 
const Aws::Vector< Schedule > & GetSchedules () const
 
bool SchedulesHasBeenSet () const
 
void SetSchedules (const Aws::Vector< Schedule > &value)
 
void SetSchedules (Aws::Vector< Schedule > &&value)
 
PolicyDetailsWithSchedules (const Aws::Vector< Schedule > &value)
 
PolicyDetailsWithSchedules (Aws::Vector< Schedule > &&value)
 
PolicyDetailsAddSchedules (const Schedule &value)
 
PolicyDetailsAddSchedules (Schedule &&value)
 
const ParametersGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Parameters &value)
 
void SetParameters (Parameters &&value)
 
PolicyDetailsWithParameters (const Parameters &value)
 
PolicyDetailsWithParameters (Parameters &&value)
 
const EventSourceGetEventSource () const
 
bool EventSourceHasBeenSet () const
 
void SetEventSource (const EventSource &value)
 
void SetEventSource (EventSource &&value)
 
PolicyDetailsWithEventSource (const EventSource &value)
 
PolicyDetailsWithEventSource (EventSource &&value)
 
const Aws::Vector< Action > & GetActions () const
 
bool ActionsHasBeenSet () const
 
void SetActions (const Aws::Vector< Action > &value)
 
void SetActions (Aws::Vector< Action > &&value)
 
PolicyDetailsWithActions (const Aws::Vector< Action > &value)
 
PolicyDetailsWithActions (Aws::Vector< Action > &&value)
 
PolicyDetailsAddActions (const Action &value)
 
PolicyDetailsAddActions (Action &&value)
 

Detailed Description

Specifies the configuration of a lifecycle policy.

See Also:


AWS API Reference

Definition at line 40 of file PolicyDetails.h.

Constructor & Destructor Documentation

◆ PolicyDetails() [1/2]

Aws::DLM::Model::PolicyDetails::PolicyDetails ( )

◆ PolicyDetails() [2/2]

Aws::DLM::Model::PolicyDetails::PolicyDetails ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionsHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::ActionsHasBeenSet ( ) const
inline

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.

Definition at line 500 of file PolicyDetails.h.

◆ AddActions() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddActions ( Action &&  value)
inline

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.

Definition at line 548 of file PolicyDetails.h.

◆ AddActions() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddActions ( const Action value)
inline

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.

Definition at line 540 of file PolicyDetails.h.

◆ AddResourceLocations() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddResourceLocations ( const ResourceLocationValues value)
inline

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.

Definition at line 257 of file PolicyDetails.h.

◆ AddResourceLocations() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddResourceLocations ( ResourceLocationValues &&  value)
inline

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.

Definition at line 267 of file PolicyDetails.h.

◆ AddResourceTypes() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddResourceTypes ( const ResourceTypeValues value)
inline

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.

Definition at line 177 of file PolicyDetails.h.

◆ AddResourceTypes() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddResourceTypes ( ResourceTypeValues &&  value)
inline

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.

Definition at line 186 of file PolicyDetails.h.

◆ AddSchedules() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddSchedules ( const Schedule value)
inline

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.

Definition at line 388 of file PolicyDetails.h.

◆ AddSchedules() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddSchedules ( Schedule &&  value)
inline

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.

Definition at line 397 of file PolicyDetails.h.

◆ AddTargetTags() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddTargetTags ( const Tag value)
inline

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.

Definition at line 317 of file PolicyDetails.h.

◆ AddTargetTags() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::AddTargetTags ( Tag &&  value)
inline

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.

Definition at line 324 of file PolicyDetails.h.

◆ EventSourceHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::EventSourceHasBeenSet ( ) const
inline

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.

Definition at line 455 of file PolicyDetails.h.

◆ GetActions()

const Aws::Vector<Action>& Aws::DLM::Model::PolicyDetails::GetActions ( ) const
inline

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.

Definition at line 492 of file PolicyDetails.h.

◆ GetEventSource()

const EventSource& Aws::DLM::Model::PolicyDetails::GetEventSource ( ) const
inline

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.

Definition at line 448 of file PolicyDetails.h.

◆ GetParameters()

const Parameters& Aws::DLM::Model::PolicyDetails::GetParameters ( ) const
inline

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.

Definition at line 405 of file PolicyDetails.h.

◆ GetPolicyType()

const PolicyTypeValues& Aws::DLM::Model::PolicyDetails::GetPolicyType ( ) const
inline

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.

Definition at line 58 of file PolicyDetails.h.

◆ GetResourceLocations()

const Aws::Vector<ResourceLocationValues>& Aws::DLM::Model::PolicyDetails::GetResourceLocations ( ) const
inline

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.

Definition at line 197 of file PolicyDetails.h.

◆ GetResourceTypes()

const Aws::Vector<ResourceTypeValues>& Aws::DLM::Model::PolicyDetails::GetResourceTypes ( ) const
inline

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.

Definition at line 123 of file PolicyDetails.h.

◆ GetSchedules()

const Aws::Vector<Schedule>& Aws::DLM::Model::PolicyDetails::GetSchedules ( ) const
inline

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.

Definition at line 334 of file PolicyDetails.h.

◆ GetTargetTags()

const Aws::Vector<Tag>& Aws::DLM::Model::PolicyDetails::GetTargetTags ( ) const
inline

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.

Definition at line 275 of file PolicyDetails.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DLM::Model::PolicyDetails::Jsonize ( ) const

◆ operator=()

PolicyDetails& Aws::DLM::Model::PolicyDetails::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ParametersHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::ParametersHasBeenSet ( ) const
inline

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.

Definition at line 412 of file PolicyDetails.h.

◆ PolicyTypeHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::PolicyTypeHasBeenSet ( ) const
inline

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.

Definition at line 69 of file PolicyDetails.h.

◆ ResourceLocationsHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::ResourceLocationsHasBeenSet ( ) const
inline

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.

Definition at line 207 of file PolicyDetails.h.

◆ ResourceTypesHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::ResourceTypesHasBeenSet ( ) const
inline

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.

Definition at line 132 of file PolicyDetails.h.

◆ SchedulesHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::SchedulesHasBeenSet ( ) const
inline

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.

Definition at line 343 of file PolicyDetails.h.

◆ SetActions() [1/2]

void Aws::DLM::Model::PolicyDetails::SetActions ( Aws::Vector< Action > &&  value)
inline

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.

Definition at line 516 of file PolicyDetails.h.

◆ SetActions() [2/2]

void Aws::DLM::Model::PolicyDetails::SetActions ( const Aws::Vector< Action > &  value)
inline

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.

Definition at line 508 of file PolicyDetails.h.

◆ SetEventSource() [1/2]

void Aws::DLM::Model::PolicyDetails::SetEventSource ( const EventSource value)
inline

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.

Definition at line 462 of file PolicyDetails.h.

◆ SetEventSource() [2/2]

void Aws::DLM::Model::PolicyDetails::SetEventSource ( EventSource &&  value)
inline

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.

Definition at line 469 of file PolicyDetails.h.

◆ SetParameters() [1/2]

void Aws::DLM::Model::PolicyDetails::SetParameters ( const Parameters value)
inline

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.

Definition at line 419 of file PolicyDetails.h.

◆ SetParameters() [2/2]

void Aws::DLM::Model::PolicyDetails::SetParameters ( Parameters &&  value)
inline

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.

Definition at line 426 of file PolicyDetails.h.

◆ SetPolicyType() [1/2]

void Aws::DLM::Model::PolicyDetails::SetPolicyType ( const PolicyTypeValues value)
inline

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.

Definition at line 80 of file PolicyDetails.h.

◆ SetPolicyType() [2/2]

void Aws::DLM::Model::PolicyDetails::SetPolicyType ( PolicyTypeValues &&  value)
inline

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.

Definition at line 91 of file PolicyDetails.h.

◆ SetResourceLocations() [1/2]

void Aws::DLM::Model::PolicyDetails::SetResourceLocations ( Aws::Vector< ResourceLocationValues > &&  value)
inline

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.

Definition at line 227 of file PolicyDetails.h.

◆ SetResourceLocations() [2/2]

void Aws::DLM::Model::PolicyDetails::SetResourceLocations ( const Aws::Vector< ResourceLocationValues > &  value)
inline

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.

Definition at line 217 of file PolicyDetails.h.

◆ SetResourceTypes() [1/2]

void Aws::DLM::Model::PolicyDetails::SetResourceTypes ( Aws::Vector< ResourceTypeValues > &&  value)
inline

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.

Definition at line 150 of file PolicyDetails.h.

◆ SetResourceTypes() [2/2]

void Aws::DLM::Model::PolicyDetails::SetResourceTypes ( const Aws::Vector< ResourceTypeValues > &  value)
inline

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.

Definition at line 141 of file PolicyDetails.h.

◆ SetSchedules() [1/2]

void Aws::DLM::Model::PolicyDetails::SetSchedules ( Aws::Vector< Schedule > &&  value)
inline

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.

Definition at line 361 of file PolicyDetails.h.

◆ SetSchedules() [2/2]

void Aws::DLM::Model::PolicyDetails::SetSchedules ( const Aws::Vector< Schedule > &  value)
inline

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.

Definition at line 352 of file PolicyDetails.h.

◆ SetTargetTags() [1/2]

void Aws::DLM::Model::PolicyDetails::SetTargetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 296 of file PolicyDetails.h.

◆ SetTargetTags() [2/2]

void Aws::DLM::Model::PolicyDetails::SetTargetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 289 of file PolicyDetails.h.

◆ TargetTagsHasBeenSet()

bool Aws::DLM::Model::PolicyDetails::TargetTagsHasBeenSet ( ) const
inline

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.

Definition at line 282 of file PolicyDetails.h.

◆ WithActions() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithActions ( Aws::Vector< Action > &&  value)
inline

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.

Definition at line 532 of file PolicyDetails.h.

◆ WithActions() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithActions ( const Aws::Vector< Action > &  value)
inline

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.

Definition at line 524 of file PolicyDetails.h.

◆ WithEventSource() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithEventSource ( const EventSource value)
inline

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.

Definition at line 476 of file PolicyDetails.h.

◆ WithEventSource() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithEventSource ( EventSource &&  value)
inline

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.

Definition at line 483 of file PolicyDetails.h.

◆ WithParameters() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithParameters ( const Parameters value)
inline

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.

Definition at line 433 of file PolicyDetails.h.

◆ WithParameters() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithParameters ( Parameters &&  value)
inline

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.

Definition at line 440 of file PolicyDetails.h.

◆ WithPolicyType() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithPolicyType ( const PolicyTypeValues value)
inline

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.

Definition at line 102 of file PolicyDetails.h.

◆ WithPolicyType() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithPolicyType ( PolicyTypeValues &&  value)
inline

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.

Definition at line 113 of file PolicyDetails.h.

◆ WithResourceLocations() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithResourceLocations ( Aws::Vector< ResourceLocationValues > &&  value)
inline

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.

Definition at line 247 of file PolicyDetails.h.

◆ WithResourceLocations() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithResourceLocations ( const Aws::Vector< ResourceLocationValues > &  value)
inline

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.

Definition at line 237 of file PolicyDetails.h.

◆ WithResourceTypes() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithResourceTypes ( Aws::Vector< ResourceTypeValues > &&  value)
inline

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.

Definition at line 168 of file PolicyDetails.h.

◆ WithResourceTypes() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithResourceTypes ( const Aws::Vector< ResourceTypeValues > &  value)
inline

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.

Definition at line 159 of file PolicyDetails.h.

◆ WithSchedules() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithSchedules ( Aws::Vector< Schedule > &&  value)
inline

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.

Definition at line 379 of file PolicyDetails.h.

◆ WithSchedules() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithSchedules ( const Aws::Vector< Schedule > &  value)
inline

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.

Definition at line 370 of file PolicyDetails.h.

◆ WithTargetTags() [1/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithTargetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 310 of file PolicyDetails.h.

◆ WithTargetTags() [2/2]

PolicyDetails& Aws::DLM::Model::PolicyDetails::WithTargetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 303 of file PolicyDetails.h.


The documentation for this class was generated from the following file: