Interface UpdateSecurityProfileRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateSecurityProfileRequest.Builder,
,UpdateSecurityProfileRequest> IotRequest.Builder
,SdkBuilder<UpdateSecurityProfileRequest.Builder,
,UpdateSecurityProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateSecurityProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalMetricsToRetain
(String... additionalMetricsToRetain) Deprecated.Use additionalMetricsToRetainV2.additionalMetricsToRetain
(Collection<String> additionalMetricsToRetain) Deprecated.Use additionalMetricsToRetainV2.additionalMetricsToRetainV2
(Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).additionalMetricsToRetainV2
(Consumer<MetricToRetain.Builder>... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).additionalMetricsToRetainV2
(MetricToRetain... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).alertTargets
(Map<AlertTargetType, AlertTarget> alertTargets) Where the alerts are sent.alertTargetsWithStrings
(Map<String, AlertTarget> alertTargets) Where the alerts are sent.behaviors
(Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.behaviors
(Consumer<Behavior.Builder>... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.Specifies the behaviors that, when violated by a device (thing), cause an alert.deleteAdditionalMetricsToRetain
(Boolean deleteAdditionalMetricsToRetain) If true, delete alladditionalMetricsToRetain
defined for this security profile.deleteAlertTargets
(Boolean deleteAlertTargets) If true, delete allalertTargets
defined for this security profile.deleteBehaviors
(Boolean deleteBehaviors) If true, delete allbehaviors
defined for this security profile.deleteMetricsExportConfig
(Boolean deleteMetricsExportConfig) Set the value as true to delete metrics export related configurations.expectedVersion
(Long expectedVersion) The expected version of the security profile.metricsExportConfig
(Consumer<MetricsExportConfig.Builder> metricsExportConfig) Specifies the MQTT topic and role ARN required for metric export.metricsExportConfig
(MetricsExportConfig metricsExportConfig) Specifies the MQTT topic and role ARN required for metric export.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.securityProfileDescription
(String securityProfileDescription) A description of the security profile.securityProfileName
(String securityProfileName) The name of the security profile you want to update.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
Specifies the behaviors that, when violated by a device (thing), cause an alert.
This is a convenience method that creates an instance of theBehavior.Builder
avoiding the need to create one manually viaBehavior.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobehaviors(List<Behavior>)
.- Parameters:
behaviors
- a consumer that will call methods onBehavior.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alertTargetsWithStrings
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
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 method that creates an instance of theMetricToRetain.Builder
avoiding the need to create one manually viaMetricToRetain.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadditionalMetricsToRetainV2(List<MetricToRetain>)
.- Parameters:
additionalMetricsToRetainV2
- a consumer that will call methods onMetricToRetain.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deleteBehaviors
If true, delete all
behaviors
defined for this security profile. If anybehaviors
are defined in the current invocation, an exception occurs.- Parameters:
deleteBehaviors
- If true, delete allbehaviors
defined for this security profile. If anybehaviors
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
If true, delete all
alertTargets
defined for this security profile. If anyalertTargets
are defined in the current invocation, an exception occurs.- Parameters:
deleteAlertTargets
- If true, delete allalertTargets
defined for this security profile. If anyalertTargets
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 anyadditionalMetricsToRetain
are defined in the current invocation, an exception occurs.- Parameters:
deleteAdditionalMetricsToRetain
- If true, delete alladditionalMetricsToRetain
defined for this security profile. If anyadditionalMetricsToRetain
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
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, aVersionConflictException
is thrown.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricsExportConfig
Specifies the MQTT topic and role ARN required for metric export.
- Parameters:
metricsExportConfig
- Specifies the MQTT topic and role ARN required for metric export.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricsExportConfig
default UpdateSecurityProfileRequest.Builder metricsExportConfig(Consumer<MetricsExportConfig.Builder> metricsExportConfig) Specifies the MQTT topic and role ARN required for metric export.
This is a convenience method that creates an instance of theMetricsExportConfig.Builder
avoiding the need to create one manually viaMetricsExportConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometricsExportConfig(MetricsExportConfig)
.- Parameters:
metricsExportConfig
- a consumer that will call methods onMetricsExportConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deleteMetricsExportConfig
Set the value as true to delete metrics export related configurations.
- Parameters:
deleteMetricsExportConfig
- Set the value as true to delete metrics export related configurations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateSecurityProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateSecurityProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-