certificate_authority_activations

Creates, updates, deletes or gets a certificate_authority_activation resource or lists certificate_authority_activations in a region

Overview

Name	certificate_authority_activations
Type	Resource
Description	Used to install the certificate authority certificate and update the certificate authority status.
Id	awscc.acmpca.certificate_authority_activations

Fields

Name	Datatype	Description
certificate_authority_arn	string	Arn of the Certificate Authority.
certificate	string	Certificate Authority certificate that will be installed in the Certificate Authority.
certificate_chain	string	Certificate chain for the Certificate Authority certificate.
status	string	The status of the Certificate Authority.
complete_certificate_chain	string	The complete certificate chain, including the Certificate Authority certificate.
region	string	AWS region.

For more information, see AWS::ACMPCA::CertificateAuthorityActivation.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CertificateAuthorityArn, Certificate, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual certificate_authority_activation.

SELECT
  region,
  certificate_authority_arn,
  certificate,
  certificate_chain,
  status,
  complete_certificate_chain
FROM awscc.acmpca.certificate_authority_activations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ certificate_authority_arn }}';

INSERT example

Use the following StackQL query and manifest file to create a new certificate_authority_activation resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.acmpca.certificate_authority_activations (
  CertificateAuthorityArn,
  Certificate,
  region
)
SELECT
  '{{ certificate_authority_arn }}',
  '{{ certificate }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.acmpca.certificate_authority_activations (
  CertificateAuthorityArn,
  Certificate,
  CertificateChain,
  Status,
  region
)
SELECT
  '{{ certificate_authority_arn }}',
  '{{ certificate }}',
  '{{ certificate_chain }}',
  '{{ status }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: certificate_authority_activation
  props:
    - name: certificate_authority_arn
      value: '{{ certificate_authority_arn }}'
    - name: certificate
      value: '{{ certificate }}'
    - name: certificate_chain
      value: '{{ certificate_chain }}'
    - name: status
      value: '{{ status }}'

UPDATE example

Use the following StackQL query and manifest file to update a certificate_authority_activation resource, using stack-deploy.

/*+ update */
UPDATE awscc.acmpca.certificate_authority_activations
SET PatchDocument = string('{{ {
    "Certificate": certificate,
    "CertificateChain": certificate_chain,
    "Status": status
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ certificate_authority_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.acmpca.certificate_authority_activations
WHERE
  Identifier = '{{ certificate_authority_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the certificate_authority_activations resource, the following permissions are required:

Create

acm-pca:ImportCertificateAuthorityCertificate,
acm-pca:UpdateCertificateAuthority

Read

acm-pca:GetCertificateAuthorityCertificate,
acm-pca:DescribeCertificateAuthority

Delete

acm-pca:UpdateCertificateAuthority

Update

acm-pca:ImportCertificateAuthorityCertificate,
acm-pca:UpdateCertificateAuthority