AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateSecurityProfileInput

import "github.com/aws/aws-sdk-go/service/iot"

type UpdateSecurityProfileInput struct { AdditionalMetricsToRetain []*string `locationName:"additionalMetricsToRetain" type:"list"` AlertTargets map[string]*AlertTarget `locationName:"alertTargets" type:"map"` Behaviors []*Behavior `locationName:"behaviors" type:"list"` DeleteAdditionalMetricsToRetain *bool `locationName:"deleteAdditionalMetricsToRetain" type:"boolean"` DeleteAlertTargets *bool `locationName:"deleteAlertTargets" type:"boolean"` DeleteBehaviors *bool `locationName:"deleteBehaviors" type:"boolean"` ExpectedVersion *int64 `location:"querystring" locationName:"expectedVersion" type:"long"` SecurityProfileDescription *string `locationName:"securityProfileDescription" type:"string"` SecurityProfileName *string `location:"uri" locationName:"securityProfileName" min:"1" type:"string" required:"true"` }

AdditionalMetricsToRetain

Type: []*string

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.

AlertTargets

Type: map[string]*AlertTarget

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

Behaviors

A Device Defender security profile behavior.

DeleteAdditionalMetricsToRetain

Type: *bool

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

DeleteAlertTargets

Type: *bool

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

DeleteBehaviors

Type: *bool

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

ExpectedVersion

Type: *int64

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 than the actual version, a VersionConflictException is thrown.

SecurityProfileDescription

Type: *string

A description of the security profile.

SecurityProfileName

Type: *string

The name of the security profile you want to update.

SecurityProfileName is a required field

Method

GoString

func (s UpdateSecurityProfileInput) GoString() string

GoString returns the string representation

SetAdditionalMetricsToRetain

func (s *UpdateSecurityProfileInput) SetAdditionalMetricsToRetain(v []*string) *UpdateSecurityProfileInput

SetAdditionalMetricsToRetain sets the AdditionalMetricsToRetain field's value.

SetAlertTargets

func (s *UpdateSecurityProfileInput) SetAlertTargets(v map[string]*AlertTarget) *UpdateSecurityProfileInput

SetAlertTargets sets the AlertTargets field's value.

SetBehaviors

func (s *UpdateSecurityProfileInput) SetBehaviors(v []*Behavior) *UpdateSecurityProfileInput

SetBehaviors sets the Behaviors field's value.

SetDeleteAdditionalMetricsToRetain

func (s *UpdateSecurityProfileInput) SetDeleteAdditionalMetricsToRetain(v bool) *UpdateSecurityProfileInput

SetDeleteAdditionalMetricsToRetain sets the DeleteAdditionalMetricsToRetain field's value.

SetDeleteAlertTargets

func (s *UpdateSecurityProfileInput) SetDeleteAlertTargets(v bool) *UpdateSecurityProfileInput

SetDeleteAlertTargets sets the DeleteAlertTargets field's value.

SetDeleteBehaviors

func (s *UpdateSecurityProfileInput) SetDeleteBehaviors(v bool) *UpdateSecurityProfileInput

SetDeleteBehaviors sets the DeleteBehaviors field's value.

SetExpectedVersion

func (s *UpdateSecurityProfileInput) SetExpectedVersion(v int64) *UpdateSecurityProfileInput

SetExpectedVersion sets the ExpectedVersion field's value.

SetSecurityProfileDescription

func (s *UpdateSecurityProfileInput) SetSecurityProfileDescription(v string) *UpdateSecurityProfileInput

SetSecurityProfileDescription sets the SecurityProfileDescription field's value.

SetSecurityProfileName

func (s *UpdateSecurityProfileInput) SetSecurityProfileName(v string) *UpdateSecurityProfileInput

SetSecurityProfileName sets the SecurityProfileName field's value.

String

func (s UpdateSecurityProfileInput) String() string

String returns the string representation

Validate

func (s *UpdateSecurityProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: