rotation_schedules

Creates, updates, deletes or gets a rotation_schedule resource or lists rotation_schedules in a region

Overview

Name	rotation_schedules
Type	Resource
Description	Resource Type definition for AWS::SecretsManager::RotationSchedule
Id	awscc.secretsmanager.rotation_schedules

Fields

get (all properties)

Name	Datatype	Description
▶hosted_rotation_lambda	object	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates. To use a rotation function that already exists, specify RotationLambdaARN instead.
secret_id	string	The ARN or name of the secret to rotate.
id	string	The ARN of the secret.
rotate_immediately_on_update	boolean	Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
rotation_lambda_arn	string	The ARN of an existing Lambda rotation function. To specify a rotation function that is also defined in this template, use the Ref function.
▶rotation_rules	object	A structure that defines the rotation configuration for this secret.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The ARN of the secret.
region	string	AWS region.

For more information, see AWS::SecretsManager::RotationSchedule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	rotation_schedules	INSERT	SecretId, region
delete_resource	rotation_schedules	DELETE	Identifier, region
update_resource	rotation_schedules	UPDATE	Identifier, PatchDocument, region
list_resources	rotation_schedules_list_only	SELECT	region
get_resource	rotation_schedules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual rotation_schedule.

SELECT
  region,
  hosted_rotation_lambda,
  secret_id,
  id,
  rotate_immediately_on_update,
  rotation_lambda_arn,
  rotation_rules
FROM awscc.secretsmanager.rotation_schedules
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all rotation_schedules in a region.

SELECT
  region,
  id
FROM awscc.secretsmanager.rotation_schedules_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.secretsmanager.rotation_schedules (
  SecretId,
  region
)
SELECT
  '{{ secret_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.secretsmanager.rotation_schedules (
  HostedRotationLambda,
  SecretId,
  RotateImmediatelyOnUpdate,
  RotationLambdaARN,
  RotationRules,
  region
)
SELECT
  '{{ hosted_rotation_lambda }}',
  '{{ secret_id }}',
  '{{ rotate_immediately_on_update }}',
  '{{ rotation_lambda_arn }}',
  '{{ rotation_rules }}',
  '{{ 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: rotation_schedule
  props:
    - name: hosted_rotation_lambda
      value:
        runtime: '{{ runtime }}'
        kms_key_arn: '{{ kms_key_arn }}'
        master_secret_arn: '{{ master_secret_arn }}'
        rotation_lambda_name: '{{ rotation_lambda_name }}'
        rotation_type: '{{ rotation_type }}'
        exclude_characters: '{{ exclude_characters }}'
        vpc_security_group_ids: '{{ vpc_security_group_ids }}'
        master_secret_kms_key_arn: '{{ master_secret_kms_key_arn }}'
        superuser_secret_arn: '{{ superuser_secret_arn }}'
        superuser_secret_kms_key_arn: '{{ superuser_secret_kms_key_arn }}'
        vpc_subnet_ids: '{{ vpc_subnet_ids }}'
    - name: secret_id
      value: '{{ secret_id }}'
    - name: rotate_immediately_on_update
      value: '{{ rotate_immediately_on_update }}'
    - name: rotation_lambda_arn
      value: '{{ rotation_lambda_arn }}'
    - name: rotation_rules
      value:
        schedule_expression: '{{ schedule_expression }}'
        duration: '{{ duration }}'
        automatically_after_days: '{{ automatically_after_days }}'

UPDATE example

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

/*+ update */
UPDATE awscc.secretsmanager.rotation_schedules
SET PatchDocument = string('{{ {
    "HostedRotationLambda": hosted_rotation_lambda,
    "RotateImmediatelyOnUpdate": rotate_immediately_on_update,
    "RotationLambdaARN": rotation_lambda_arn,
    "RotationRules": rotation_rules
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Read

secretsmanager:DescribeSecret

Create

secretsmanager:RotateSecret,
secretsmanager:DescribeSecret,
lambda:InvokeFunction

Update

secretsmanager:RotateSecret,
secretsmanager:DescribeSecret,
lambda:InvokeFunction

List

secretsmanager:DescribeSecret,
secretsmanager:ListSecrets

Delete

secretsmanager:CancelRotateSecret,
secretsmanager:DescribeSecret