Start Resource State Update

imagebuilder_start_resource_state_update

R Documentation

Begin asynchronous resource state update for lifecycle changes to the specified image resources

Description

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

Usage

imagebuilder_start_resource_state_update(resourceArn, state,
  executionRole, includeResources, exclusionRules, updateAt, clientToken)

Arguments

resourceArn

[required] The ARN of the Image Builder resource that is updated. The state update might also impact associated resources.

state

[required] Indicates the lifecycle action to take for this request.

executionRole

The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.

includeResources

A list of image resources to update state for.

exclusionRules

Skip action on the image resource and associated resources if specified exclusion rules are met.

updateAt

The timestamp that indicates when resources are updated by a lifecycle action.

clientToken

[required] Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Value

A list with the following syntax:

list(
  lifecycleExecutionId = "string",
  resourceArn = "string"
)

Request syntax

svc$start_resource_state_update(
  resourceArn = "string",
  state = list(
    status = "AVAILABLE"|"DELETED"|"DEPRECATED"|"DISABLED"
  ),
  executionRole = "string",
  includeResources = list(
    amis = TRUE|FALSE,
    snapshots = TRUE|FALSE,
    containers = TRUE|FALSE
  ),
  exclusionRules = list(
    amis = list(
      isPublic = TRUE|FALSE,
      regions = list(
        "string"
      ),
      sharedAccounts = list(
        "string"
      ),
      lastLaunched = list(
        value = 123,
        unit = "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
      ),
      tagMap = list(
        "string"
      )
    )
  ),
  updateAt = as.POSIXct(
    "2015-01-01"
  ),
  clientToken = "string"
)