software.amazon.awssdk.services.iot.model

Interface UpdateSecurityProfileRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateSecurityProfileRequest.Builder,UpdateSecurityProfileRequest>, IotRequest.Builder, SdkBuilder<UpdateSecurityProfileRequest.Builder,UpdateSecurityProfileRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateSecurityProfileRequest

public static interface UpdateSecurityProfileRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<UpdateSecurityProfileRequest.Builder,UpdateSecurityProfileRequest>

Method Summary

Modifier and Type	Method and Description
UpdateSecurityProfileRequest.Builder	additionalMetricsToRetain(Collection<String> additionalMetricsToRetain) Deprecated. Use additionalMetricsToRetainV2.
UpdateSecurityProfileRequest.Builder	additionalMetricsToRetain(String... additionalMetricsToRetain) Deprecated. Use additionalMetricsToRetainV2.
UpdateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(Consumer<MetricToRetain.Builder>... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest.Builder	alertTargets(Map<AlertTargetType,AlertTarget> alertTargets) Where the alerts are sent.
UpdateSecurityProfileRequest.Builder	alertTargetsWithStrings(Map<String,AlertTarget> alertTargets) Where the alerts are sent.
UpdateSecurityProfileRequest.Builder	behaviors(Behavior... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileRequest.Builder	behaviors(Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileRequest.Builder	behaviors(Consumer<Behavior.Builder>... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileRequest.Builder	deleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain) If true, delete all additionalMetricsToRetain defined for this security profile.
UpdateSecurityProfileRequest.Builder	deleteAlertTargets(Boolean deleteAlertTargets) If true, delete all alertTargets defined for this security profile.
UpdateSecurityProfileRequest.Builder	deleteBehaviors(Boolean deleteBehaviors) If true, delete all behaviors defined for this security profile.
UpdateSecurityProfileRequest.Builder	expectedVersion(Long expectedVersion) The expected version of the security profile.
UpdateSecurityProfileRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateSecurityProfileRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateSecurityProfileRequest.Builder	securityProfileDescription(String securityProfileDescription) A description of the security profile.
UpdateSecurityProfileRequest.Builder	securityProfileName(String securityProfileName) The name of the security profile you want to update.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

securityProfileName

UpdateSecurityProfileRequest.Builder securityProfileName(String securityProfileName)

The name of the security profile you want to update.

Parameters:

securityProfileName - The name of the security profile you want to update.

Returns:

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

securityProfileDescription

UpdateSecurityProfileRequest.Builder securityProfileDescription(String securityProfileDescription)

A description of the security profile.

Parameters:

securityProfileDescription - A description of the security profile.

Returns:

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

behaviors

UpdateSecurityProfileRequest.Builder behaviors(Collection<Behavior> behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:

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

behaviors

UpdateSecurityProfileRequest.Builder behaviors(Behavior... behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:

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

behaviors

UpdateSecurityProfileRequest.Builder behaviors(Consumer<Behavior.Builder>... behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

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 #behaviors(List).

Parameters:

behaviors - 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:

#behaviors(List)

alertTargetsWithStrings

UpdateSecurityProfileRequest.Builder alertTargetsWithStrings(Map<String,AlertTarget> alertTargets)

Where the alerts are sent. (Alerts are always sent to the console.)

Parameters:

alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

Returns:

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

alertTargets

UpdateSecurityProfileRequest.Builder alertTargets(Map<AlertTargetType,AlertTarget> alertTargets)

Where the alerts are sent. (Alerts are always sent to the console.)

Parameters:

alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

Returns:

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

additionalMetricsToRetain

@Deprecated
UpdateSecurityProfileRequest.Builder additionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated. Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetain - Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

additionalMetricsToRetain

@Deprecated
UpdateSecurityProfileRequest.Builder additionalMetricsToRetain(String... additionalMetricsToRetain)

Deprecated. Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetain - Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

additionalMetricsToRetainV2

UpdateSecurityProfileRequest.Builder additionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2)

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetainV2 - A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

additionalMetricsToRetainV2

UpdateSecurityProfileRequest.Builder additionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2)

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetainV2 - A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

additionalMetricsToRetainV2

UpdateSecurityProfileRequest.Builder additionalMetricsToRetainV2(Consumer<MetricToRetain.Builder>... additionalMetricsToRetainV2)

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

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 #additionalMetricsToRetainV2(List).

Parameters:

additionalMetricsToRetainV2 - 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:

#additionalMetricsToRetainV2(List)

deleteBehaviors

UpdateSecurityProfileRequest.Builder deleteBehaviors(Boolean deleteBehaviors)

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Parameters:

deleteBehaviors - If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Returns:

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

deleteAlertTargets

UpdateSecurityProfileRequest.Builder deleteAlertTargets(Boolean deleteAlertTargets)

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Parameters:

deleteAlertTargets - If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

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

deleteAdditionalMetricsToRetain

UpdateSecurityProfileRequest.Builder deleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain)

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Parameters:

deleteAdditionalMetricsToRetain - If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

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

expectedVersion

UpdateSecurityProfileRequest.Builder expectedVersion(Long expectedVersion)

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Parameters:

expectedVersion - The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Returns:

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

overrideConfiguration

UpdateSecurityProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateSecurityProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder