Class: Aws::Imagebuilder::Types::UpdateLifecyclePolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::UpdateLifecyclePolicyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time.

• #description ⇒ String

  Optional description for the lifecycle policy.

• #execution_role ⇒ String

  The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

• #lifecycle_policy_arn ⇒ String

  The Amazon Resource Name (ARN) of the lifecycle policy resource.

• #policy_details ⇒ Array<Types::LifecyclePolicyDetail>

  The configuration details for a lifecycle policy resource.

• #resource_selection ⇒ Types::LifecyclePolicyResourceSelection

  Selection criteria for resources that the lifecycle policy applies to.

• #resource_type ⇒ String

  The type of image resource that the lifecycle policy applies to.

• #status ⇒ String

  Indicates whether the lifecycle policy resource is enabled.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Optional description for the lifecycle policy. Because the update replaces the entire configuration, omitting this property removes any existing description.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ String

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_policy_arn ⇒ String

The Amazon Resource Name (ARN) of the lifecycle policy resource.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#policy_details ⇒ Array<Types::LifecyclePolicyDetail>

The configuration details for a lifecycle policy resource.

Returns:

• (Array<Types::LifecyclePolicyDetail>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_selection ⇒ Types::LifecyclePolicyResourceSelection

Selection criteria for resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.

Returns:

• (Types::LifecyclePolicyResourceSelection)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.

Returns:

• (String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 9681

class UpdateLifecyclePolicyRequest < Struct.new(
  :lifecycle_policy_arn,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end