Skip to content

Enable Image Block Public Access

ec2_enable_image_block_public_access R Documentation

Enables block public access for AMIs at the account level in the specified Amazon Web Services Region

Description

Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.

The API can take up to 10 minutes to configure this setting. During this time, if you run get_image_block_public_access_state, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing.

For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.

Usage

ec2_enable_image_block_public_access(ImageBlockPublicAccessState,
  DryRun)

Arguments

ImageBlockPublicAccessState

[required] Specify block-new-sharing to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  ImageBlockPublicAccessState = "block-new-sharing"
)

Request syntax

svc$enable_image_block_public_access(
  ImageBlockPublicAccessState = "block-new-sharing",
  DryRun = TRUE|FALSE
)