Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Shield.Types.Subscription

Description

Synopsis

data Subscription = Subscription' {
- timeCommitmentInSeconds :: Maybe Natural
- startTime :: Maybe POSIX
- limits :: Maybe [Limit]
- autoRenew :: Maybe AutoRenew
- endTime :: Maybe POSIX
- proactiveEngagementStatus :: Maybe ProactiveEngagementStatus
- subscriptionArn :: Maybe Text
- subscriptionLimits :: SubscriptionLimits
}
newSubscription :: SubscriptionLimits -> Subscription
subscription_timeCommitmentInSeconds :: Lens' Subscription (Maybe Natural)
subscription_startTime :: Lens' Subscription (Maybe UTCTime)
subscription_limits :: Lens' Subscription (Maybe [Limit])
subscription_autoRenew :: Lens' Subscription (Maybe AutoRenew)
subscription_endTime :: Lens' Subscription (Maybe UTCTime)
subscription_proactiveEngagementStatus :: Lens' Subscription (Maybe ProactiveEngagementStatus)
subscription_subscriptionArn :: Lens' Subscription (Maybe Text)
subscription_subscriptionLimits :: Lens' Subscription SubscriptionLimits

Documentation

data Subscription Source #

Information about the Shield Advanced subscription for an account.

See: newSubscription smart constructor.

Constructors

Subscription'

Fields

timeCommitmentInSeconds :: Maybe Natural
The length, in seconds, of the Shield Advanced subscription for the account.
startTime :: Maybe POSIX
The start time of the subscription, in Unix time in seconds. For more information see timestamp.
limits :: Maybe [Limit]
Specifies how many protections of a given type you can create.
autoRenew :: Maybe AutoRenew
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.
endTime :: Maybe POSIX
The date and time your subscription will end.
proactiveEngagementStatus :: Maybe ProactiveEngagementStatus
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.
subscriptionArn :: Maybe Text
The ARN (Amazon Resource Name) of the subscription.
subscriptionLimits :: SubscriptionLimits
Limits settings for your subscription.

Instances

Instances details

Eq Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods (==) :: Subscription -> Subscription -> Bool # (/=) :: Subscription -> Subscription -> Bool #
Read Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods readsPrec :: Int -> ReadS Subscription # readList :: ReadS [Subscription] # readPrec :: ReadPrec Subscription # readListPrec :: ReadPrec [Subscription] #
Show Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods showsPrec :: Int -> Subscription -> ShowS # show :: Subscription -> String # showList :: [Subscription] -> ShowS #
Generic Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Associated Types type Rep Subscription :: Type -> Type # Methods from :: Subscription -> Rep Subscription x # to :: Rep Subscription x -> Subscription #
NFData Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods rnf :: Subscription -> () #
Hashable Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods hashWithSalt :: Int -> Subscription -> Int # hash :: Subscription -> Int #
FromJSON Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription Methods parseJSON :: Value -> Parser Subscription # parseJSONList :: Value -> Parser [Subscription] #
type Rep Subscription Source #
Instance details Defined in Amazonka.Shield.Types.Subscription type Rep Subscription = D1 ('MetaData "Subscription" "Amazonka.Shield.Types.Subscription" "libZSservicesZSamazonka-shieldZSamazonka-shield" 'False) (C1 ('MetaCons "Subscription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "timeCommitmentInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Limit])) :: S1 ('MetaSel ('Just "autoRenew") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoRenew)))) :: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "proactiveEngagementStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProactiveEngagementStatus))) :: (S1 ('MetaSel ('Just "subscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subscriptionLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubscriptionLimits)))))

newSubscription Source #

Arguments

:: SubscriptionLimits	`$sel:subscriptionLimits:Subscription'`
-> Subscription

Create a value of Subscription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timeCommitmentInSeconds:Subscription', subscription_timeCommitmentInSeconds - The length, in seconds, of the Shield Advanced subscription for the account.

$sel:startTime:Subscription', subscription_startTime - The start time of the subscription, in Unix time in seconds. For more information see timestamp.

$sel:limits:Subscription', subscription_limits - Specifies how many protections of a given type you can create.

$sel:autoRenew:Subscription', subscription_autoRenew - 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.

$sel:endTime:Subscription', subscription_endTime - The date and time your subscription will end.

$sel:proactiveEngagementStatus:Subscription', subscription_proactiveEngagementStatus - 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.

$sel:subscriptionArn:Subscription', subscription_subscriptionArn - The ARN (Amazon Resource Name) of the subscription.

$sel:subscriptionLimits:Subscription', subscription_subscriptionLimits - Limits settings for your subscription.

subscription_timeCommitmentInSeconds :: Lens' Subscription (Maybe Natural) Source #

The length, in seconds, of the Shield Advanced subscription for the account.

subscription_startTime :: Lens' Subscription (Maybe UTCTime) Source #

The start time of the subscription, in Unix time in seconds. For more information see timestamp.

subscription_limits :: Lens' Subscription (Maybe [Limit]) Source #

Specifies how many protections of a given type you can create.

subscription_autoRenew :: Lens' Subscription (Maybe AutoRenew) Source #

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.

subscription_endTime :: Lens' Subscription (Maybe UTCTime) Source #

The date and time your subscription will end.

subscription_proactiveEngagementStatus :: Lens' Subscription (Maybe ProactiveEngagementStatus) Source #

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.

subscription_subscriptionArn :: Lens' Subscription (Maybe Text) Source #

The ARN (Amazon Resource Name) of the subscription.

subscription_subscriptionLimits :: Lens' Subscription SubscriptionLimits Source #

Limits settings for your subscription.