subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Name	subscriptions
Type	Resource
Id	aws.shield.subscriptions

Fields

The following fields are returned by SELECT queries:

describe_subscription

Name	Datatype	Description
auto_renew	string	If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged. (ENABLED, DISABLED)
end_time	string (date-time)	The date and time your subscription will end.
limits	array	Specifies how many protections of a given type you can create.
proactive_engagement_status	string	If ENABLED, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support. If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. (ENABLED, DISABLED, PENDING)
start_time	string (date-time)	The start time of the subscription, in Unix time in seconds.
subscription_arn	string	The ARN (Amazon Resource Name) of the subscription. (pattern: <code>^arn:aws.*</code>)
subscription_limits	object	Limits settings for your subscription.
time_commitment_in_seconds	integer (int64)	The length, in seconds, of the Shield Advanced subscription for the account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_subscription	select	region		Provides details about the Shield Advanced subscription for an account.
create_subscription	insert	region		Activates Shield Advanced for an account. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed. When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
update_subscription	update	region		Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
delete_subscription	delete	region		Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_subscription

Provides details about the Shield Advanced subscription for an account.

SELECT
auto_renew,
end_time,
limits,
proactive_engagement_status,
start_time,
subscription_arn,
subscription_limits,
time_commitment_in_seconds
FROM aws.shield.subscriptions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_subscription

Activates Shield Advanced for an account. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed. When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

INSERT INTO aws.shield.subscriptions (
region
)
SELECT 
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: subscriptions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the subscriptions resource.

UPDATE examples

update_subscription

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated. For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.

UPDATE aws.shield.subscriptions
SET 
AutoRenew = '{{ AutoRenew }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_subscription

Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

DELETE FROM aws.shield.subscriptions
WHERE region = '{{ region }}' --required
;