Class: Aws::Imagebuilder::Types::CreateLifecyclePolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::CreateLifecyclePolicyRequest

Defined in:

gems/aws-sdk-imagebuilder/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.

• #dry_run ⇒ Boolean

  Validates the required permissions and request parameters without performing the operation.

• #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.

• #name ⇒ String

  The name of the lifecycle policy to create.

• #policy_details ⇒ Array<Types::LifecyclePolicyDetail>

  Configuration details for the lifecycle policy rules.

• #resource_selection ⇒ Types::LifecyclePolicyResourceSelection

  Selection criteria for the resources that the lifecycle policy applies to.

• #resource_type ⇒ String

  The type of Image Builder resource that the lifecycle policy applies to.

• #status ⇒ String

  Indicates whether the lifecycle policy resource is enabled.

• #tags ⇒ Hash<String,String>

  Tags to apply to the lifecycle policy resource.

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 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2228

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

#description ⇒ String

Optional description for the lifecycle policy.

Returns:

• (String)

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

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

#dry_run ⇒ Boolean

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Returns:

• (Boolean)

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

class CreateLifecyclePolicyRequest < Struct.new(
  :name,
  :description,
  :status,
  :execution_role,
  :resource_type,
  :policy_details,
  :resource_selection,
  :tags,
  :client_token,
  :dry_run)
  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. You must have permission to pass the role, and the role's trust policy must allow the Image Builder service principal to assume it.

Returns:

• (String)

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

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

#name ⇒ String

The name of the lifecycle policy to create. Policy names must be unique to your account in each Amazon Web Services Region. Image Builder generates the policy ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. You can't change the name after creation.

Returns:

• (String)

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

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

#policy_details ⇒ Array<Types::LifecyclePolicyDetail>

Configuration details for the lifecycle policy rules. A policy can contain at most one rule per action type: one DELETE, one DEPRECATE, and one DISABLE.

Returns:

• (Array<Types::LifecyclePolicyDetail>)

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

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

#resource_selection ⇒ Types::LifecyclePolicyResourceSelection

Selection criteria for the 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 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 2228

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

#resource_type ⇒ String

The type of Image Builder resource that the lifecycle policy applies to. The resource type determines the allowed rule actions: policies for AMI-based Image Builder images support DELETE, DEPRECATE, and DISABLE, and policies for container-based Image Builder images support only DELETE. You can't change the resource type after creation.

Returns:

• (String)

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

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

#status ⇒ String

Indicates whether the lifecycle policy resource is enabled. If you don't specify a status, it defaults to ENABLED. Only enabled policies run on their schedule.

Returns:

• (String)

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

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

#tags ⇒ Hash<String,String>

Tags to apply to the lifecycle policy resource.

Returns:

• (Hash<String,String>)

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

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