Class: Aws::Shield::Types::Subscription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb

Overview

Information about the Shield Advanced subscription for an account.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_renewString

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.

Returns:

  • (String)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The date and time your subscription will end.

Returns:

  • (Time)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#limitsArray<Types::Limit>

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

Returns:



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#proactive_engagement_statusString

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.

Returns:

  • (String)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The start time of the subscription, in Unix time in seconds.

Returns:

  • (Time)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_arnString

The ARN (Amazon Resource Name) of the subscription.

Returns:

  • (String)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_limitsTypes::SubscriptionLimits

Limits settings for your subscription.



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end

#time_commitment_in_secondsInteger

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

Returns:

  • (Integer)


1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 1931

class Subscription < Struct.new(
  :start_time,
  :end_time,
  :time_commitment_in_seconds,
  :auto_renew,
  :limits,
  :proactive_engagement_status,
  :subscription_limits,
  :subscription_arn)
  SENSITIVE = []
  include Aws::Structure
end