Client

imagebuilder

R Documentation

EC2 Image Builder¶

Description¶

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

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

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"
  ),
  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: CancelImageCreation cancels the creation of Image
cancel_lifecycle_execution: Cancel a specific image lifecycle policy runtime instance
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
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: Create a lifecycle policy resource
create_workflow: Create 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: Delete the specified lifecycle policy resource
delete_workflow: Deletes a specific workflow resource
get_component: Gets a component object
get_component_policy: Gets a component policy
get_container_recipe: Retrieves a container recipe
get_container_recipe_policy: Retrieves the policy for a container recipe
get_distribution_configuration: Gets a distribution configuration
get_image: Gets an image
get_image_pipeline: Gets an image pipeline
get_image_policy: Gets an image policy
get_image_recipe: Gets an image recipe
get_image_recipe_policy: Gets an image recipe policy
get_infrastructure_configuration: Gets an infrastructure configuration
get_lifecycle_execution: Get the runtime information that was logged for a specific runtime instance of the lifecycle policy
get_lifecycle_policy: Get details for the specified image lifecycle policy
get_workflow: Get a workflow resource object
get_workflow_execution: Get the runtime information that was logged for a specific runtime instance of the workflow
get_workflow_step_execution: Get the runtime information that was logged for a specific runtime instance of the workflow step
import_component: Imports a component and transforms its data into a component document
import_vm_image: When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data
list_component_build_versions: Returns the list of component build versions for the specified semantic version
list_components: Returns the list of components that can be filtered by name, or by using the listed filters to streamline results
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: List 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: List resources that the runtime instance of the image lifecycle identified for lifecycle actions
list_lifecycle_executions: Get the lifecycle runtime history for the specified resource
list_lifecycle_policies: Get 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: Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account
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 build 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 image
put_image_policy: Applies a policy to an image
put_image_recipe_policy: Applies a policy to an image recipe
send_workflow_step_action: Pauses or resumes image creation when the associated workflow runs a WaitForAction step
start_image_pipeline_execution: Manually triggers a pipeline to create an image
start_resource_state_update: Begin asynchronous resource state update for lifecycle changes to the specified image resources
tag_resource: Adds a tag to a resource
untag_resource: Removes a tag from a resource
update_distribution_configuration: Updates a new distribution configuration
update_image_pipeline: Updates an image pipeline
update_infrastructure_configuration: Updates a new infrastructure configuration
update_lifecycle_policy: Update the specified lifecycle policy

Examples¶

## Not run: 
svc <- imagebuilder()
svc$cancel_image_creation(
  Foo = 123
)

## End(Not run)