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	aws.apigateway.client_certificates

Fields

Name	Datatype	Description
client_certificate_id	string
description	string	The description of the client certificate.
tags	array	The collection of tags. Each tag element is associated with a given resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all client_certificates in a region.

SELECT
region,
client_certificate_id,
description,
tags
FROM aws.apigateway.client_certificates
WHERE region = 'us-east-1';

Gets all properties from an individual client_certificate.

SELECT
region,
client_certificate_id,
description,
tags
FROM aws.apigateway.client_certificates
WHERE region = 'us-east-1' AND data__Identifier = '<ClientCertificateId>';

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 aws.apigateway.client_certificates (
 Description,
 Tags,
 region
)
SELECT 
'{{ Description }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.client_certificates (
 Description,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

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 }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigateway.client_certificates
WHERE data__Identifier = '<ClientCertificateId>'
AND region = 'us-east-1';

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