EC2 Image Builder¶

Description¶

EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images (AMIs) and container images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

For an introduction to the service concepts that these API operations work with, see How Image Builder works in the EC2 Image Builder User Guide.

Usage¶

imagebuilder(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- imagebuilder(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`cancel_image_creation`	Cancels the creation of an image
`cancel_lifecycle_execution`	Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started
`create_component`	Creates a new component that can be used to build, validate, test, and assess your image
`create_container_recipe`	Creates a new container recipe
`create_distribution_configuration`	Creates a new distribution configuration
`create_image`	Creates a new image along with all configured output resources defined in the distribution configuration
`create_image_pipeline`	Creates a new image pipeline
`create_image_recipe`	Creates a new image recipe
`create_infrastructure_configuration`	Creates a new infrastructure configuration
`create_lifecycle_policy`	Creates a lifecycle policy resource
`create_workflow`	Creates a new workflow or a new version of an existing workflow
`delete_component`	Deletes a component build version
`delete_container_recipe`	Deletes a container recipe
`delete_distribution_configuration`	Deletes a distribution configuration
`delete_image`	Deletes an Image Builder image resource
`delete_image_pipeline`	Deletes an image pipeline
`delete_image_recipe`	Deletes an image recipe
`delete_infrastructure_configuration`	Deletes an infrastructure configuration
`delete_lifecycle_policy`	Deletes the specified lifecycle policy resource
`delete_workflow`	Deletes a specific workflow resource
`distribute_image`	Distributes an existing AMI to target Regions and accounts without running the full image build process
`get_component`	Retrieves a component object
`get_component_policy`	Retrieves a component policy
`get_container_recipe`	Retrieves a container recipe
`get_container_recipe_policy`	Retrieves the policy for a container recipe
`get_distribution_configuration`	Retrieves a distribution configuration
`get_image`	Retrieves an image
`get_image_pipeline`	Retrieves an image pipeline
`get_image_policy`	Retrieves an image policy
`get_image_recipe`	Retrieves an image recipe
`get_image_recipe_policy`	Retrieves an image recipe policy
`get_infrastructure_configuration`	Retrieves an infrastructure configuration
`get_lifecycle_execution`	Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started
`get_lifecycle_policy`	Retrieves details for the specified image lifecycle policy
`get_marketplace_resource`	Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource
`get_workflow`	Retrieves a workflow resource object
`get_workflow_execution`	Retrieves runtime information for a specific runtime instance of the workflow
`get_workflow_step_execution`	Retrieves runtime information for a specific runtime instance of the workflow step
`import_component`	Imports a component and transforms its data into a component document
`import_disk_image`	Imports a Windows operating system image from a verified Microsoft ISO disk file
`import_vm_image`	Creates an Image Builder image resource from an Amazon EC2 VM import task
`list_component_build_versions`	Returns a list of component build versions for the specified component version ARN
`list_components`	Returns the list of components that you have access to
`list_container_recipes`	Returns a list of container recipes
`list_distribution_configurations`	Returns a list of distribution configurations
`list_image_build_versions`	Returns a list of image build versions
`list_image_packages`	Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time
`list_image_pipeline_images`	Returns a list of images created by the specified pipeline
`list_image_pipelines`	Returns a list of image pipelines
`list_image_recipes`	Returns a list of image recipes
`list_images`	Returns the list of images that you have access to
`list_image_scan_finding_aggregations`	Returns a list of image scan aggregations for your account
`list_image_scan_findings`	Returns a list of image scan findings for your account
`list_infrastructure_configurations`	Returns a list of infrastructure configurations
`list_lifecycle_execution_resources`	Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions
`list_lifecycle_executions`	Retrieves the lifecycle runtime history for the specified resource
`list_lifecycle_policies`	Retrieves a list of lifecycle policies in your Amazon Web Services account
`list_tags_for_resource`	Returns the list of tags for the specified resource
`list_waiting_workflow_steps`	Lists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond
`list_workflow_build_versions`	Returns a list of build versions for a specific workflow resource
`list_workflow_executions`	Returns a list of workflow runtime instance metadata objects for a specific image build version
`list_workflows`	Lists workflow versions based on filtering parameters
`list_workflow_step_executions`	Returns runtime data for each step in a runtime instance of the workflow that you specify in the request
`put_component_policy`	Applies a policy to a component
`put_container_recipe_policy`	Applies a policy to a container recipe
`put_image_policy`	Applies a policy to an image
`put_image_recipe_policy`	Applies a policy to an image recipe
`retry_image`	Retries a failed or canceled image build without rebuilding the phases that already completed
`send_workflow_step_action`	Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue
`start_image_pipeline_execution`	Manually triggers a pipeline to create an image
`start_resource_state_update`	Begins an ad-hoc state change for the specified image build version
`tag_resource`	Adds a tag to a resource
`untag_resource`	Removes a tag from a resource
`update_distribution_configuration`	Updates a distribution configuration
`update_image_pipeline`	Updates an image pipeline
`update_infrastructure_configuration`	Updates an infrastructure configuration
`update_lifecycle_policy`	Updates the specified lifecycle policy

Examples¶

svc <- imagebuilder()
svc$cancel_image_creation(
  Foo = 123
)