client_certificates

Creates, updates, deletes or gets a client_certificate resource or lists client_certificates in a region

Overview

Name	client_certificates
Type	Resource
Description	The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
Id	awscc.apigateway.client_certificates

Fields

get (all properties)

Name	Datatype	Description
client_certificate_id	string
description	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
client_certificate_id	string
region	string	AWS region.

For more information, see AWS::ApiGateway::ClientCertificate.

Methods

Name	Resource	Accessible by	Required Params
create_resource	client_certificates	INSERT	region
delete_resource	client_certificates	DELETE	Identifier, region
update_resource	client_certificates	UPDATE	Identifier, PatchDocument, region
list_resources	client_certificates_list_only	SELECT	region
get_resource	client_certificates	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual client_certificate.

SELECT
  region,
  client_certificate_id,
  description,
  tags
FROM awscc.apigateway.client_certificates
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ client_certificate_id }}';

list (identifiers only)

Lists all client_certificates in a region.

SELECT
  region,
  client_certificate_id
FROM awscc.apigateway.client_certificates_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.client_certificates (
  Description,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.client_certificates (
  Description,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ tags }}',
  '{{ 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: client_certificate
  props:
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.apigateway.client_certificates
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ client_certificate_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.client_certificates
WHERE
  Identifier = '{{ client_certificate_id }}' 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 client_certificates resource, the following permissions are required:

Create

apigateway:POST,
apigateway:GET,
apigateway:PUT

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PATCH,
apigateway:PUT,
apigateway:DELETE

Delete

apigateway:DELETE

List

apigateway:GET