server_certificates

Creates, updates, deletes or gets a server_certificate resource or lists server_certificates in a region

Overview

Name	server_certificates
Type	Resource
Description	Resource Type definition for AWS::IAM::ServerCertificate
Id	awscc.iam.server_certificates

Fields

get (all properties)

Name	Datatype	Description
certificate_body	string
certificate_chain	string
server_certificate_name	string
path	string
private_key	string
arn	string	Amazon Resource Name (ARN) of the server certificate
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
server_certificate_name	string
region	string	AWS region.

For more information, see AWS::IAM::ServerCertificate.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual server_certificate.

SELECT
  region,
  certificate_body,
  certificate_chain,
  server_certificate_name,
  path,
  private_key,
  arn,
  tags
FROM awscc.iam.server_certificates
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ server_certificate_name }}';

list (identifiers only)

Lists all server_certificates in a region.

SELECT
  region,
  server_certificate_name
FROM awscc.iam.server_certificates_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iam.server_certificates (
  CertificateBody,
  CertificateChain,
  ServerCertificateName,
  Path,
  PrivateKey,
  Tags,
  region
)
SELECT
  '{{ certificate_body }}',
  '{{ certificate_chain }}',
  '{{ server_certificate_name }}',
  '{{ path }}',
  '{{ private_key }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iam.server_certificates (
  CertificateBody,
  CertificateChain,
  ServerCertificateName,
  Path,
  PrivateKey,
  Tags,
  region
)
SELECT
  '{{ certificate_body }}',
  '{{ certificate_chain }}',
  '{{ server_certificate_name }}',
  '{{ path }}',
  '{{ private_key }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: server_certificate
    props:
      - name: certificate_body
        value: '{{ certificate_body }}'
      - name: certificate_chain
        value: '{{ certificate_chain }}'
      - name: server_certificate_name
        value: '{{ server_certificate_name }}'
      - name: path
        value: '{{ path }}'
      - name: private_key
        value: '{{ private_key }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iam.server_certificates
SET PatchDocument = string('{{ {
    "Path": path,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ server_certificate_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iam.server_certificates
WHERE
  Identifier = '{{ server_certificate_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

iam:UploadServerCertificate,
iam:TagServerCertificate,
iam:GetServerCertificate

Read

iam:GetServerCertificate

Update

iam:TagServerCertificate,
iam:UntagServerCertificate,
iam:ListServerCertificateTags,
iam:GetServerCertificate

Delete

iam:DeleteServerCertificate

List

iam:ListServerCertificates,
iam:GetServerCertificate