signing_profiles

Creates, updates, deletes or gets a signing_profile resource or lists signing_profiles in a region

Overview

Name	signing_profiles
Type	Resource
Description	A signing profile is a signing template that can be used to carry out a pre-defined signing job.
Id	awscc.signer.signing_profiles

Fields

get (all properties)

Name	Datatype	Description
profile_name	string	A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name.
profile_version	string	A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.
arn	string	The Amazon Resource Name (ARN) of the specified signing profile.
▶signature_validity_period	object	Signature validity period of the profile.
platform_id	string	The ID of the target signing platform.
▶tags	array	A list of tags associated with the signing profile.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified signing profile.
region	string	AWS region.

For more information, see AWS::Signer::SigningProfile.

Methods

Name	Resource	Accessible by	Required Params
create_resource	signing_profiles	INSERT	PlatformId, region
delete_resource	signing_profiles	DELETE	Identifier, region
update_resource	signing_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	signing_profiles_list_only	SELECT	region
get_resource	signing_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual signing_profile.

SELECT
  region,
  profile_name,
  profile_version,
  arn,
  profile_version_arn,
  signature_validity_period,
  platform_id,
  tags
FROM awscc.signer.signing_profiles
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all signing_profiles in a region.

SELECT
  region,
  arn
FROM awscc.signer.signing_profiles_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.signer.signing_profiles (
  PlatformId,
  region
)
SELECT
  '{{ platform_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.signer.signing_profiles (
  SignatureValidityPeriod,
  PlatformId,
  Tags,
  region
)
SELECT
  '{{ signature_validity_period }}',
  '{{ platform_id }}',
  '{{ 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: signing_profile
  props:
    - name: signature_validity_period
      value:
        value: '{{ value }}'
        type: '{{ type }}'
    - name: platform_id
      value: '{{ platform_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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

Create

signer:PutSigningProfile,
signer:TagResource

Read

signer:GetSigningProfile

Delete

signer:CancelSigningProfile,
signer:GetSigningProfile

List

signer:ListSigningProfiles

Update

signer:TagResource,
signer:UntagResource,
signer:GetSigningProfile