software.amazon.awssdk.services.shield.model

Interface Subscription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Subscription.Builder,Subscription>, SdkBuilder<Subscription.Builder,Subscription>, SdkPojo

Enclosing class:

Subscription

public static interface Subscription.Builder
extends SdkPojo, CopyableBuilder<Subscription.Builder,Subscription>

Method Summary

Modifier and Type	Method and Description
Subscription.Builder	autoRenew(AutoRenew autoRenew) If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
Subscription.Builder	autoRenew(String autoRenew) If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
Subscription.Builder	endTime(Instant endTime) The date and time your subscription will end.
Subscription.Builder	limits(Collection<Limit> limits) Specifies how many protections of a given type you can create.
Subscription.Builder	limits(Consumer<Limit.Builder>... limits) Specifies how many protections of a given type you can create.
Subscription.Builder	limits(Limit... limits) Specifies how many protections of a given type you can create.
Subscription.Builder	proactiveEngagementStatus(ProactiveEngagementStatus 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.
Subscription.Builder	proactiveEngagementStatus(String 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.
Subscription.Builder	startTime(Instant startTime) The start time of the subscription, in Unix time in seconds.
Subscription.Builder	subscriptionArn(String subscriptionArn) The ARN (Amazon Resource Name) of the subscription.
default Subscription.Builder	subscriptionLimits(Consumer<SubscriptionLimits.Builder> subscriptionLimits) Limits settings for your subscription.
Subscription.Builder	subscriptionLimits(SubscriptionLimits subscriptionLimits) Limits settings for your subscription.
Subscription.Builder	timeCommitmentInSeconds(Long timeCommitmentInSeconds) The length, in seconds, of the Shield Advanced subscription for the account.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

startTime

Subscription.Builder startTime(Instant startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

Subscription.Builder endTime(Instant endTime)

The date and time your subscription will end.

Parameters:

endTime - The date and time your subscription will end.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeCommitmentInSeconds

Subscription.Builder timeCommitmentInSeconds(Long timeCommitmentInSeconds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

autoRenew

Subscription.Builder autoRenew(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AutoRenew, AutoRenew

autoRenew

Subscription.Builder autoRenew(AutoRenew 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AutoRenew, AutoRenew

limits

Subscription.Builder limits(Collection<Limit> limits)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

limits

Subscription.Builder limits(Limit... limits)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

limits

Subscription.Builder limits(Consumer<Limit.Builder>... limits)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #limits(List).

Parameters:

limits - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#limits(List)

proactiveEngagementStatus

Subscription.Builder proactiveEngagementStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProactiveEngagementStatus, ProactiveEngagementStatus

proactiveEngagementStatus

Subscription.Builder proactiveEngagementStatus(ProactiveEngagementStatus 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProactiveEngagementStatus, ProactiveEngagementStatus

subscriptionLimits

Subscription.Builder subscriptionLimits(SubscriptionLimits subscriptionLimits)

Limits settings for your subscription.

Parameters:

subscriptionLimits - Limits settings for your subscription.

Returns:

Returns a reference to this object so that method calls can be chained together.

subscriptionLimits

default Subscription.Builder subscriptionLimits(Consumer<SubscriptionLimits.Builder> subscriptionLimits)

Limits settings for your subscription.

This is a convenience that creates an instance of the SubscriptionLimits.Builder avoiding the need to create one manually via SubscriptionLimits.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subscriptionLimits(SubscriptionLimits).

Parameters:

subscriptionLimits - a consumer that will call methods on SubscriptionLimits.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

subscriptionLimits(SubscriptionLimits)

subscriptionArn

Subscription.Builder subscriptionArn(String subscriptionArn)

The ARN (Amazon Resource Name) of the subscription.

Parameters:

subscriptionArn - The ARN (Amazon Resource Name) of the subscription.

Returns:

Returns a reference to this object so that method calls can be chained together.