Interface CreateSecurityProfileRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateSecurityProfileRequest.Builder,
,CreateSecurityProfileRequest> IotRequest.Builder
,SdkBuilder<CreateSecurityProfileRequest.Builder,
,CreateSecurityProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateSecurityProfileRequest
-
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) Specifies the destinations to which alerts are sent.alertTargetsWithStrings
(Map<String, AlertTarget> alertTargets) Specifies the destinations to which 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.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 you are giving to the security profile.tags
(Collection<Tag> tags) Metadata that can be used to manage the security profile.tags
(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the security profile.Metadata that can be used to manage the security profile.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 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
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
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
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'sbehaviors
, 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'sbehaviors
, 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
This is a convenience method that creates an instance of thebehaviors
, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.MetricToRetain.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:
-
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
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
Metadata that can be used to manage the security profile.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 CreateSecurityProfileRequest.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:
-
overrideConfiguration
CreateSecurityProfileRequest.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
CreateSecurityProfileRequest.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.
-