paws.security.identity (version 0.4.0)

acm: 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)

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.

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.

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"
  ),
  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
delete_certificate	Deletes a certificate and its associated private key
describe_certificate	Returns detailed metadata about the specified ACM certificate
export_certificate	Exports a private certificate issued by a private certificate authority (CA) for use anywhere
get_account_configuration	Returns the account configuration options associated with an Amazon Web Services account
get_certificate	Retrieves an Amazon-issued certificate and its certificate chain
import_certificate	Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM
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
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
update_certificate_options	Updates a certificate

Examples

if (FALSE) {
svc <- acm()
svc$add_tags_to_certificate(
  Foo = 123
)
}