software.amazon.awssdk.services.iot.model

Interface CreateSecurityProfileRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateSecurityProfileRequest

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

Method Summary

Modifier and Type	Method and Description
CreateSecurityProfileRequest.Builder	additionalMetricsToRetain(Collection<String> additionalMetricsToRetain) Deprecated. Use additionalMetricsToRetainV2.
CreateSecurityProfileRequest.Builder	additionalMetricsToRetain(String... additionalMetricsToRetain) Deprecated. Use additionalMetricsToRetainV2.
CreateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(Consumer<MetricToRetain.Builder>... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest.Builder	additionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest.Builder	alertTargets(Map<AlertTargetType,AlertTarget> alertTargets) Specifies the destinations to which alerts are sent.
CreateSecurityProfileRequest.Builder	alertTargetsWithStrings(Map<String,AlertTarget> alertTargets) Specifies the destinations to which alerts are sent.
CreateSecurityProfileRequest.Builder	behaviors(Behavior... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
CreateSecurityProfileRequest.Builder	behaviors(Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
CreateSecurityProfileRequest.Builder	behaviors(Consumer<Behavior.Builder>... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
CreateSecurityProfileRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSecurityProfileRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSecurityProfileRequest.Builder	securityProfileDescription(String securityProfileDescription) A description of the security profile.
CreateSecurityProfileRequest.Builder	securityProfileName(String securityProfileName) The name you are giving to the security profile.
CreateSecurityProfileRequest.Builder	tags(Collection<Tag> tags) Metadata that can be used to manage the security profile.
CreateSecurityProfileRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the security profile.
CreateSecurityProfileRequest.Builder	tags(Tag... tags) Metadata that can be used to manage the security profile.

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

CreateSecurityProfileRequest.Builder securityProfileName(String securityProfileName)

The name you are giving to the security profile.

Parameters:

securityProfileName - The name you are giving to the security profile.

Returns:

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

securityProfileDescription

CreateSecurityProfileRequest.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

CreateSecurityProfileRequest.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

CreateSecurityProfileRequest.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

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

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

This is a convenience method that creates an instance of the Behavior.Builder avoiding the need to create one manually via Behavior.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #behaviors(List).

Parameters:

behaviors - a consumer that will call methods on Behavior.Builder

Returns:

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

See Also:

#behaviors(java.util.Collection)

alertTargetsWithStrings

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

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Parameters:

alertTargets - Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Returns:

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

alertTargets

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

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Parameters:

alertTargets - Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Returns:

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

additionalMetricsToRetain

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

Deprecated. Use additionalMetricsToRetainV2.

Please use CreateSecurityProfileRequest$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 CreateSecurityProfileRequest$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
CreateSecurityProfileRequest.Builder additionalMetricsToRetain(String... additionalMetricsToRetain)

Deprecated. Use additionalMetricsToRetainV2.

Please use CreateSecurityProfileRequest$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 CreateSecurityProfileRequest$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

CreateSecurityProfileRequest.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

CreateSecurityProfileRequest.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

CreateSecurityProfileRequest.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 method that creates an instance of the MetricToRetain.Builder avoiding the need to create one manually via MetricToRetain.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #additionalMetricsToRetainV2(List).

Parameters:

additionalMetricsToRetainV2 - a consumer that will call methods on MetricToRetain.Builder

Returns:

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

See Also:

#additionalMetricsToRetainV2(java.util.Collection)

tags

CreateSecurityProfileRequest.Builder tags(Collection<Tag> tags)

Metadata that can be used to manage the security profile.

Parameters:

tags - Metadata that can be used to manage the security profile.

Returns:

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

tags

CreateSecurityProfileRequest.Builder tags(Tag... tags)

Metadata that can be used to manage the security profile.

Parameters:

tags - Metadata that can be used to manage the security profile.

Returns:

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

tags

CreateSecurityProfileRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata that can be used to manage the security profile.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateSecurityProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder