Skip to content

Create Certificate

lightsail_create_certificate R Documentation

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service

Description

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the attach_certificate_to_distribution action to use the certificate and its domains with your distribution. Or use the update_container_service action to use the certificate and its domains with your container service.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

Usage

lightsail_create_certificate(certificateName, domainName,
  subjectAlternativeNames, tags)

Arguments

certificateName

[required] The name for the certificate.
domainName

[required] The domain name (example.com) for the certificate.
subjectAlternativeNames

An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

You can specify a maximum of nine alternate domains (in addition to the primary domain name).

Wildcard domain entries (⁠*.example.com⁠) are not supported.
tags

The tag keys and optional values to add to the certificate during create.

Use the tag_resource action to tag a resource after it's created.

Value

A list with the following syntax:

list(
  certificate = list(
    certificateArn = "string",
    certificateName = "string",
    domainName = "string",
    certificateDetail = list(
      arn = "string",
      name = "string",
      domainName = "string",
      status = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED",
      serialNumber = "string",
      subjectAlternativeNames = list(
        "string"
      ),
      domainValidationRecords = list(
        list(
          domainName = "string",
          resourceRecord = list(
            name = "string",
            type = "string",
            value = "string"
          ),
          dnsRecordCreationState = list(
            code = "SUCCEEDED"|"STARTED"|"FAILED",
            message = "string"
          ),
          validationStatus = "PENDING_VALIDATION"|"FAILED"|"SUCCESS"
        )
      ),
      requestFailureReason = "string",
      inUseResourceCount = 123,
      keyAlgorithm = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      issuedAt = as.POSIXct(
        "2015-01-01"
      ),
      issuerCA = "string",
      notBefore = as.POSIXct(
        "2015-01-01"
      ),
      notAfter = as.POSIXct(
        "2015-01-01"
      ),
      eligibleToRenew = "string",
      renewalSummary = list(
        domainValidationRecords = list(
          list(
            domainName = "string",
            resourceRecord = list(
              name = "string",
              type = "string",
              value = "string"
            ),
            dnsRecordCreationState = list(
              code = "SUCCEEDED"|"STARTED"|"FAILED",
              message = "string"
            ),
            validationStatus = "PENDING_VALIDATION"|"FAILED"|"SUCCESS"
          )
        ),
        renewalStatus = "PendingAutoRenewal"|"PendingValidation"|"Success"|"Failed",
        renewalStatusReason = "string",
        updatedAt = as.POSIXct(
          "2015-01-01"
        )
      ),
      revokedAt = as.POSIXct(
        "2015-01-01"
      ),
      revocationReason = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      supportCode = "string"
    ),
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    )
  ),
  operations = list(
    list(
      id = "string",
      resourceName = "string",
      resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      location = list(
        availabilityZone = "string",
        regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
      ),
      isTerminal = TRUE|FALSE,
      operationDetails = "string",
      operationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"SetIpAddressType"|"CreateCertificate"|"DeleteCertificate"|"CreateContainerService"|"UpdateContainerService"|"DeleteContainerService"|"CreateContainerServiceDeployment"|"CreateContainerServiceRegistryLogin"|"RegisterContainerImage"|"DeleteContainerImage"|"CreateBucket"|"DeleteBucket"|"CreateBucketAccessKey"|"DeleteBucketAccessKey"|"UpdateBucketBundle"|"UpdateBucket"|"SetResourceAccessForBucket"|"UpdateInstanceMetadataOptions"|"StartGUISession"|"StopGUISession"|"SetupInstanceHttps",
      status = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded",
      statusChangedAt = as.POSIXct(
        "2015-01-01"
      ),
      errorCode = "string",
      errorDetails = "string"
    )
  )
)

Request syntax

svc$create_certificate(
  certificateName = "string",
  domainName = "string",
  subjectAlternativeNames = list(
    "string"
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)