AWS Certificate Manager¶

Description¶

Certificate Manager

You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.

Usage¶

acm(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 <- acm(
  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¶

`add_tags_to_certificate`	Adds one or more tags to an ACM certificate
`create_acme_domain_validation`	Creates a domain validation for an ACME endpoint
`create_acme_endpoint`	Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL
`create_acme_external_account_binding`	Creates an external account binding (EAB) for an ACME endpoint
`delete_acme_domain_validation`	Deletes a domain validation
`delete_acme_endpoint`	Deletes an ACME endpoint
`delete_acme_external_account_binding`	Deletes an external account binding
`delete_certificate`	Deletes a certificate and its associated private key
`describe_acme_account`	Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding
`describe_acme_domain_validation`	Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation
`describe_acme_endpoint`	Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration
`describe_acme_external_account_binding`	Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history
`describe_certificate`	Returns detailed metadata about the specified ACM certificate
`export_certificate`	Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere
`get_account_configuration`	Returns the account configuration options associated with an Amazon Web Services account
`get_acme_external_account_binding_credentials`	Retrieves the key ID and MAC key credentials for an external account binding
`get_certificate`	Retrieves a certificate and its certificate chain
`import_certificate`	Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM
`list_acme_accounts`	Retrieves a list of ACME accounts registered with the specified ACME endpoint
`list_acme_domain_validations`	Retrieves a list of domain validations for the specified ACME endpoint
`list_acme_endpoints`	Retrieves a list of ACME endpoints in your account
`list_acme_external_account_bindings`	Retrieves a list of external account bindings for the specified ACME endpoint
`list_certificate_domain_validations`	Returns per-domain validation summaries for an ACM certificate
`list_certificates`	Retrieves a list of certificate ARNs and domain names
`list_tags_for_certificate`	Lists the tags that have been applied to the ACM certificate
`list_tags_for_resource`	Lists the tags associated with an ACM resource
`put_account_configuration`	Adds or modifies account-level configurations in ACM
`remove_tags_from_certificate`	Remove one or more tags from an ACM certificate
`renew_certificate`	Renews an eligible ACM certificate
`request_certificate`	Requests an ACM certificate for use with other Amazon Web Services services
`resend_validation_email`	Resends the email that requests domain ownership validation
`revoke_acme_account`	Revokes an ACME account, preventing it from requesting or revoking certificates
`revoke_acme_external_account_binding`	Revokes an external account binding, preventing new ACME accounts from being registered using this binding
`revoke_certificate`	Revokes a public ACM certificate
`search_certificates`	Retrieves a list of certificates matching search criteria
`tag_resource`	Adds one or more tags to an ACM resource
`untag_resource`	Removes one or more tags from an ACM resource
`update_acme_domain_validation`	Updates the prevalidation configuration of an existing domain validation
`update_acme_endpoint`	Updates the configuration of an existing ACME endpoint
`update_certificate_options`	Updates certificate options

Examples¶

svc <- acm()
svc$add_tags_to_certificate(
  Foo = 123
)