Documentation ¶
Overview ¶
Package fms provides the client and types for making API requests to Firewall Management Service.
This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide (http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html).
See https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01 for more information on this service.
See fms package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/fms/
Using the Client ¶
To contact Firewall Management Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Firewall Management Service client FMS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fms/#New
Index ¶
- Constants
- type AssociateAdminAccountInput
- type AssociateAdminAccountOutput
- type ComplianceViolator
- func (s ComplianceViolator) GoString() string
- func (s *ComplianceViolator) SetResourceId(v string) *ComplianceViolator
- func (s *ComplianceViolator) SetResourceType(v string) *ComplianceViolator
- func (s *ComplianceViolator) SetViolationReason(v string) *ComplianceViolator
- func (s ComplianceViolator) String() string
- type DeleteNotificationChannelInput
- type DeleteNotificationChannelOutput
- type DeletePolicyInput
- type DeletePolicyOutput
- type DisassociateAdminAccountInput
- type DisassociateAdminAccountOutput
- type EvaluationResult
- func (s EvaluationResult) GoString() string
- func (s *EvaluationResult) SetComplianceStatus(v string) *EvaluationResult
- func (s *EvaluationResult) SetEvaluationLimitExceeded(v bool) *EvaluationResult
- func (s *EvaluationResult) SetViolatorCount(v int64) *EvaluationResult
- func (s EvaluationResult) String() string
- type FMS
- func (c *FMS) AssociateAdminAccount(input *AssociateAdminAccountInput) (*AssociateAdminAccountOutput, error)
- func (c *FMS) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) (req *request.Request, output *AssociateAdminAccountOutput)
- func (c *FMS) AssociateAdminAccountWithContext(ctx aws.Context, input *AssociateAdminAccountInput, opts ...request.Option) (*AssociateAdminAccountOutput, error)
- func (c *FMS) DeleteNotificationChannel(input *DeleteNotificationChannelInput) (*DeleteNotificationChannelOutput, error)
- func (c *FMS) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) (req *request.Request, output *DeleteNotificationChannelOutput)
- func (c *FMS) DeleteNotificationChannelWithContext(ctx aws.Context, input *DeleteNotificationChannelInput, opts ...request.Option) (*DeleteNotificationChannelOutput, error)
- func (c *FMS) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error)
- func (c *FMS) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput)
- func (c *FMS) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error)
- func (c *FMS) DisassociateAdminAccount(input *DisassociateAdminAccountInput) (*DisassociateAdminAccountOutput, error)
- func (c *FMS) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) (req *request.Request, output *DisassociateAdminAccountOutput)
- func (c *FMS) DisassociateAdminAccountWithContext(ctx aws.Context, input *DisassociateAdminAccountInput, opts ...request.Option) (*DisassociateAdminAccountOutput, error)
- func (c *FMS) GetAdminAccount(input *GetAdminAccountInput) (*GetAdminAccountOutput, error)
- func (c *FMS) GetAdminAccountRequest(input *GetAdminAccountInput) (req *request.Request, output *GetAdminAccountOutput)
- func (c *FMS) GetAdminAccountWithContext(ctx aws.Context, input *GetAdminAccountInput, opts ...request.Option) (*GetAdminAccountOutput, error)
- func (c *FMS) GetComplianceDetail(input *GetComplianceDetailInput) (*GetComplianceDetailOutput, error)
- func (c *FMS) GetComplianceDetailRequest(input *GetComplianceDetailInput) (req *request.Request, output *GetComplianceDetailOutput)
- func (c *FMS) GetComplianceDetailWithContext(ctx aws.Context, input *GetComplianceDetailInput, opts ...request.Option) (*GetComplianceDetailOutput, error)
- func (c *FMS) GetNotificationChannel(input *GetNotificationChannelInput) (*GetNotificationChannelOutput, error)
- func (c *FMS) GetNotificationChannelRequest(input *GetNotificationChannelInput) (req *request.Request, output *GetNotificationChannelOutput)
- func (c *FMS) GetNotificationChannelWithContext(ctx aws.Context, input *GetNotificationChannelInput, opts ...request.Option) (*GetNotificationChannelOutput, error)
- func (c *FMS) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error)
- func (c *FMS) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, output *GetPolicyOutput)
- func (c *FMS) GetPolicyWithContext(ctx aws.Context, input *GetPolicyInput, opts ...request.Option) (*GetPolicyOutput, error)
- func (c *FMS) ListComplianceStatus(input *ListComplianceStatusInput) (*ListComplianceStatusOutput, error)
- func (c *FMS) ListComplianceStatusRequest(input *ListComplianceStatusInput) (req *request.Request, output *ListComplianceStatusOutput)
- func (c *FMS) ListComplianceStatusWithContext(ctx aws.Context, input *ListComplianceStatusInput, opts ...request.Option) (*ListComplianceStatusOutput, error)
- func (c *FMS) ListPolicies(input *ListPoliciesInput) (*ListPoliciesOutput, error)
- func (c *FMS) ListPoliciesRequest(input *ListPoliciesInput) (req *request.Request, output *ListPoliciesOutput)
- func (c *FMS) ListPoliciesWithContext(ctx aws.Context, input *ListPoliciesInput, opts ...request.Option) (*ListPoliciesOutput, error)
- func (c *FMS) PutNotificationChannel(input *PutNotificationChannelInput) (*PutNotificationChannelOutput, error)
- func (c *FMS) PutNotificationChannelRequest(input *PutNotificationChannelInput) (req *request.Request, output *PutNotificationChannelOutput)
- func (c *FMS) PutNotificationChannelWithContext(ctx aws.Context, input *PutNotificationChannelInput, opts ...request.Option) (*PutNotificationChannelOutput, error)
- func (c *FMS) PutPolicy(input *PutPolicyInput) (*PutPolicyOutput, error)
- func (c *FMS) PutPolicyRequest(input *PutPolicyInput) (req *request.Request, output *PutPolicyOutput)
- func (c *FMS) PutPolicyWithContext(ctx aws.Context, input *PutPolicyInput, opts ...request.Option) (*PutPolicyOutput, error)
- type GetAdminAccountInput
- type GetAdminAccountOutput
- type GetComplianceDetailInput
- func (s GetComplianceDetailInput) GoString() string
- func (s *GetComplianceDetailInput) SetMemberAccount(v string) *GetComplianceDetailInput
- func (s *GetComplianceDetailInput) SetPolicyId(v string) *GetComplianceDetailInput
- func (s GetComplianceDetailInput) String() string
- func (s *GetComplianceDetailInput) Validate() error
- type GetComplianceDetailOutput
- type GetNotificationChannelInput
- type GetNotificationChannelOutput
- type GetPolicyInput
- type GetPolicyOutput
- type ListComplianceStatusInput
- func (s ListComplianceStatusInput) GoString() string
- func (s *ListComplianceStatusInput) SetMaxResults(v int64) *ListComplianceStatusInput
- func (s *ListComplianceStatusInput) SetNextToken(v string) *ListComplianceStatusInput
- func (s *ListComplianceStatusInput) SetPolicyId(v string) *ListComplianceStatusInput
- func (s ListComplianceStatusInput) String() string
- func (s *ListComplianceStatusInput) Validate() error
- type ListComplianceStatusOutput
- func (s ListComplianceStatusOutput) GoString() string
- func (s *ListComplianceStatusOutput) SetNextToken(v string) *ListComplianceStatusOutput
- func (s *ListComplianceStatusOutput) SetPolicyComplianceStatusList(v []*PolicyComplianceStatus) *ListComplianceStatusOutput
- func (s ListComplianceStatusOutput) String() string
- type ListPoliciesInput
- type ListPoliciesOutput
- type Policy
- func (s Policy) GoString() string
- func (s *Policy) SetExcludeResourceTags(v bool) *Policy
- func (s *Policy) SetPolicyId(v string) *Policy
- func (s *Policy) SetPolicyName(v string) *Policy
- func (s *Policy) SetPolicyUpdateToken(v string) *Policy
- func (s *Policy) SetRemediationEnabled(v bool) *Policy
- func (s *Policy) SetResourceTags(v []*ResourceTag) *Policy
- func (s *Policy) SetResourceType(v string) *Policy
- func (s *Policy) SetSecurityServicePolicyData(v *SecurityServicePolicyData) *Policy
- func (s Policy) String() string
- func (s *Policy) Validate() error
- type PolicyComplianceDetail
- func (s PolicyComplianceDetail) GoString() string
- func (s *PolicyComplianceDetail) SetEvaluationLimitExceeded(v bool) *PolicyComplianceDetail
- func (s *PolicyComplianceDetail) SetExpiredAt(v time.Time) *PolicyComplianceDetail
- func (s *PolicyComplianceDetail) SetMemberAccount(v string) *PolicyComplianceDetail
- func (s *PolicyComplianceDetail) SetPolicyId(v string) *PolicyComplianceDetail
- func (s *PolicyComplianceDetail) SetPolicyOwner(v string) *PolicyComplianceDetail
- func (s *PolicyComplianceDetail) SetViolators(v []*ComplianceViolator) *PolicyComplianceDetail
- func (s PolicyComplianceDetail) String() string
- type PolicyComplianceStatus
- func (s PolicyComplianceStatus) GoString() string
- func (s *PolicyComplianceStatus) SetEvaluationResults(v []*EvaluationResult) *PolicyComplianceStatus
- func (s *PolicyComplianceStatus) SetLastUpdated(v time.Time) *PolicyComplianceStatus
- func (s *PolicyComplianceStatus) SetMemberAccount(v string) *PolicyComplianceStatus
- func (s *PolicyComplianceStatus) SetPolicyId(v string) *PolicyComplianceStatus
- func (s *PolicyComplianceStatus) SetPolicyName(v string) *PolicyComplianceStatus
- func (s *PolicyComplianceStatus) SetPolicyOwner(v string) *PolicyComplianceStatus
- func (s PolicyComplianceStatus) String() string
- type PolicySummary
- func (s PolicySummary) GoString() string
- func (s *PolicySummary) SetPolicyArn(v string) *PolicySummary
- func (s *PolicySummary) SetPolicyId(v string) *PolicySummary
- func (s *PolicySummary) SetPolicyName(v string) *PolicySummary
- func (s *PolicySummary) SetRemediationEnabled(v bool) *PolicySummary
- func (s *PolicySummary) SetResourceType(v string) *PolicySummary
- func (s *PolicySummary) SetSecurityServiceType(v string) *PolicySummary
- func (s PolicySummary) String() string
- type PutNotificationChannelInput
- func (s PutNotificationChannelInput) GoString() string
- func (s *PutNotificationChannelInput) SetSnsRoleName(v string) *PutNotificationChannelInput
- func (s *PutNotificationChannelInput) SetSnsTopicArn(v string) *PutNotificationChannelInput
- func (s PutNotificationChannelInput) String() string
- func (s *PutNotificationChannelInput) Validate() error
- type PutNotificationChannelOutput
- type PutPolicyInput
- type PutPolicyOutput
- type ResourceTag
- type SecurityServicePolicyData
- func (s SecurityServicePolicyData) GoString() string
- func (s *SecurityServicePolicyData) SetManagedServiceData(v string) *SecurityServicePolicyData
- func (s *SecurityServicePolicyData) SetType(v string) *SecurityServicePolicyData
- func (s SecurityServicePolicyData) String() string
- func (s *SecurityServicePolicyData) Validate() error
Constants ¶
const ( // PolicyComplianceStatusTypeCompliant is a PolicyComplianceStatusType enum value PolicyComplianceStatusTypeCompliant = "COMPLIANT" // PolicyComplianceStatusTypeNonCompliant is a PolicyComplianceStatusType enum value PolicyComplianceStatusTypeNonCompliant = "NON_COMPLIANT" )
const ( // ViolationReasonWebAclMissingRuleGroup is a ViolationReason enum value ViolationReasonWebAclMissingRuleGroup = "WEB_ACL_MISSING_RULE_GROUP" // ViolationReasonResourceMissingWebAcl is a ViolationReason enum value ViolationReasonResourceMissingWebAcl = "RESOURCE_MISSING_WEB_ACL" // ViolationReasonResourceIncorrectWebAcl is a ViolationReason enum value ViolationReasonResourceIncorrectWebAcl = "RESOURCE_INCORRECT_WEB_ACL" )
const ( // ErrCodeInternalErrorException for service response error code // "InternalErrorException". // // The operation failed because of a system problem, even though the request // was valid. Retry your request. ErrCodeInternalErrorException = "InternalErrorException" // ErrCodeInvalidInputException for service response error code // "InvalidInputException". // // The parameters of the request were invalid. ErrCodeInvalidInputException = "InvalidInputException" // ErrCodeInvalidOperationException for service response error code // "InvalidOperationException". // // The operation failed because there was nothing to do. For example, you might // have submitted an AssociateAdminAccount request, but the account ID that // you submitted was already set as the AWS Firewall Manager administrator. ErrCodeInvalidOperationException = "InvalidOperationException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The operation exceeds a resource limit, for example, the maximum number of // policy objects that you can create for an AWS account. For more information, // see Firewall Manager Limits (http://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) // in the AWS WAF Developer Guide. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The specified resource was not found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" )
const ( ServiceName = "fms" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "FMS" // ServiceID is a unique identifer of a specific service. )
Service information constants
const (
// SecurityServiceTypeWaf is a SecurityServiceType enum value
SecurityServiceTypeWaf = "WAF"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociateAdminAccountInput ¶
type AssociateAdminAccountInput struct { // The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall // Manager administrator account. This can be an AWS Organizations master account // or a member account. For more information about AWS Organizations and master // accounts, see Managing the AWS Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html). // // AdminAccount is a required field AdminAccount *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (AssociateAdminAccountInput) GoString ¶
func (s AssociateAdminAccountInput) GoString() string
GoString returns the string representation
func (*AssociateAdminAccountInput) SetAdminAccount ¶
func (s *AssociateAdminAccountInput) SetAdminAccount(v string) *AssociateAdminAccountInput
SetAdminAccount sets the AdminAccount field's value.
func (AssociateAdminAccountInput) String ¶
func (s AssociateAdminAccountInput) String() string
String returns the string representation
func (*AssociateAdminAccountInput) Validate ¶
func (s *AssociateAdminAccountInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateAdminAccountOutput ¶
type AssociateAdminAccountOutput struct {
// contains filtered or unexported fields
}
func (AssociateAdminAccountOutput) GoString ¶
func (s AssociateAdminAccountOutput) GoString() string
GoString returns the string representation
func (AssociateAdminAccountOutput) String ¶
func (s AssociateAdminAccountOutput) String() string
String returns the string representation
type ComplianceViolator ¶
type ComplianceViolator struct { // The resource ID. ResourceId *string `min:"1" type:"string"` // The resource type. This is in the format shown in AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). // Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. ResourceType *string `min:"1" type:"string"` // The reason that the resource is not protected by the policy. ViolationReason *string `type:"string" enum:"ViolationReason"` // contains filtered or unexported fields }
Details of the resource that is not protected by the policy.
func (ComplianceViolator) GoString ¶
func (s ComplianceViolator) GoString() string
GoString returns the string representation
func (*ComplianceViolator) SetResourceId ¶
func (s *ComplianceViolator) SetResourceId(v string) *ComplianceViolator
SetResourceId sets the ResourceId field's value.
func (*ComplianceViolator) SetResourceType ¶
func (s *ComplianceViolator) SetResourceType(v string) *ComplianceViolator
SetResourceType sets the ResourceType field's value.
func (*ComplianceViolator) SetViolationReason ¶
func (s *ComplianceViolator) SetViolationReason(v string) *ComplianceViolator
SetViolationReason sets the ViolationReason field's value.
func (ComplianceViolator) String ¶
func (s ComplianceViolator) String() string
String returns the string representation
type DeleteNotificationChannelInput ¶
type DeleteNotificationChannelInput struct {
// contains filtered or unexported fields
}
func (DeleteNotificationChannelInput) GoString ¶
func (s DeleteNotificationChannelInput) GoString() string
GoString returns the string representation
func (DeleteNotificationChannelInput) String ¶
func (s DeleteNotificationChannelInput) String() string
String returns the string representation
type DeleteNotificationChannelOutput ¶
type DeleteNotificationChannelOutput struct {
// contains filtered or unexported fields
}
func (DeleteNotificationChannelOutput) GoString ¶
func (s DeleteNotificationChannelOutput) GoString() string
GoString returns the string representation
func (DeleteNotificationChannelOutput) String ¶
func (s DeleteNotificationChannelOutput) String() string
String returns the string representation
type DeletePolicyInput ¶
type DeletePolicyInput struct { // The ID of the policy that you want to delete. PolicyId is returned by PutPolicy // and by ListPolicies. // // PolicyId is a required field PolicyId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeletePolicyInput) GoString ¶
func (s DeletePolicyInput) GoString() string
GoString returns the string representation
func (*DeletePolicyInput) SetPolicyId ¶
func (s *DeletePolicyInput) SetPolicyId(v string) *DeletePolicyInput
SetPolicyId sets the PolicyId field's value.
func (DeletePolicyInput) String ¶
func (s DeletePolicyInput) String() string
String returns the string representation
func (*DeletePolicyInput) Validate ¶
func (s *DeletePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePolicyOutput ¶
type DeletePolicyOutput struct {
// contains filtered or unexported fields
}
func (DeletePolicyOutput) GoString ¶
func (s DeletePolicyOutput) GoString() string
GoString returns the string representation
func (DeletePolicyOutput) String ¶
func (s DeletePolicyOutput) String() string
String returns the string representation
type DisassociateAdminAccountInput ¶
type DisassociateAdminAccountInput struct {
// contains filtered or unexported fields
}
func (DisassociateAdminAccountInput) GoString ¶
func (s DisassociateAdminAccountInput) GoString() string
GoString returns the string representation
func (DisassociateAdminAccountInput) String ¶
func (s DisassociateAdminAccountInput) String() string
String returns the string representation
type DisassociateAdminAccountOutput ¶
type DisassociateAdminAccountOutput struct {
// contains filtered or unexported fields
}
func (DisassociateAdminAccountOutput) GoString ¶
func (s DisassociateAdminAccountOutput) GoString() string
GoString returns the string representation
func (DisassociateAdminAccountOutput) String ¶
func (s DisassociateAdminAccountOutput) String() string
String returns the string representation
type EvaluationResult ¶
type EvaluationResult struct { // Describes an AWS account's compliance with the AWS Firewall Manager policy. ComplianceStatus *string `type:"string" enum:"PolicyComplianceStatusType"` // Indicates that over 100 resources are non-compliant with the AWS Firewall // Manager policy. EvaluationLimitExceeded *bool `type:"boolean"` // Number of resources that are non-compliant with the specified policy. A resource // is considered non-compliant if it is not associated with the specified policy. ViolatorCount *int64 `type:"long"` // contains filtered or unexported fields }
Describes the compliance status for the account. An account is considered non-compliant if it includes resources that are not protected by the specified policy.
func (EvaluationResult) GoString ¶
func (s EvaluationResult) GoString() string
GoString returns the string representation
func (*EvaluationResult) SetComplianceStatus ¶
func (s *EvaluationResult) SetComplianceStatus(v string) *EvaluationResult
SetComplianceStatus sets the ComplianceStatus field's value.
func (*EvaluationResult) SetEvaluationLimitExceeded ¶
func (s *EvaluationResult) SetEvaluationLimitExceeded(v bool) *EvaluationResult
SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.
func (*EvaluationResult) SetViolatorCount ¶
func (s *EvaluationResult) SetViolatorCount(v int64) *EvaluationResult
SetViolatorCount sets the ViolatorCount field's value.
func (EvaluationResult) String ¶
func (s EvaluationResult) String() string
String returns the string representation
type FMS ¶
FMS provides the API operation methods for making requests to Firewall Management Service. See this package's package overview docs for details on the service.
FMS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *FMS
New creates a new instance of the FMS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a FMS client from just a session. svc := fms.New(mySession) // Create a FMS client with additional configuration svc := fms.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*FMS) AssociateAdminAccount ¶
func (c *FMS) AssociateAdminAccount(input *AssociateAdminAccountInput) (*AssociateAdminAccountOutput, error)
AssociateAdminAccount API operation for Firewall Management Service.
Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with a master account in AWS Organizations or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.
The account that you associate with AWS Firewall Manager is called the AWS Firewall manager administrator account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation AssociateAdminAccount for usage and error information.
Returned Error Codes:
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInvalidInputException "InvalidInputException" The parameters of the request were invalid.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccount
func (*FMS) AssociateAdminAccountRequest ¶
func (c *FMS) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) (req *request.Request, output *AssociateAdminAccountOutput)
AssociateAdminAccountRequest generates a "aws/request.Request" representing the client's request for the AssociateAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AssociateAdminAccount for more information on using the AssociateAdminAccount API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AssociateAdminAccountRequest method. req, resp := client.AssociateAdminAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccount
func (*FMS) AssociateAdminAccountWithContext ¶
func (c *FMS) AssociateAdminAccountWithContext(ctx aws.Context, input *AssociateAdminAccountInput, opts ...request.Option) (*AssociateAdminAccountOutput, error)
AssociateAdminAccountWithContext is the same as AssociateAdminAccount with the addition of the ability to pass a context and additional request options.
See AssociateAdminAccount for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) DeleteNotificationChannel ¶
func (c *FMS) DeleteNotificationChannel(input *DeleteNotificationChannelInput) (*DeleteNotificationChannelOutput, error)
DeleteNotificationChannel API operation for Firewall Management Service.
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation DeleteNotificationChannel for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannel
func (*FMS) DeleteNotificationChannelRequest ¶
func (c *FMS) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) (req *request.Request, output *DeleteNotificationChannelOutput)
DeleteNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteNotificationChannel for more information on using the DeleteNotificationChannel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteNotificationChannelRequest method. req, resp := client.DeleteNotificationChannelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannel
func (*FMS) DeleteNotificationChannelWithContext ¶
func (c *FMS) DeleteNotificationChannelWithContext(ctx aws.Context, input *DeleteNotificationChannelInput, opts ...request.Option) (*DeleteNotificationChannelOutput, error)
DeleteNotificationChannelWithContext is the same as DeleteNotificationChannel with the addition of the ability to pass a context and additional request options.
See DeleteNotificationChannel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) DeletePolicy ¶
func (c *FMS) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error)
DeletePolicy API operation for Firewall Management Service.
Permanently deletes an AWS Firewall Manager policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation DeletePolicy for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicy
func (*FMS) DeletePolicyRequest ¶
func (c *FMS) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput)
DeletePolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeletePolicy for more information on using the DeletePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeletePolicyRequest method. req, resp := client.DeletePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicy
func (*FMS) DeletePolicyWithContext ¶
func (c *FMS) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error)
DeletePolicyWithContext is the same as DeletePolicy with the addition of the ability to pass a context and additional request options.
See DeletePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) DisassociateAdminAccount ¶
func (c *FMS) DisassociateAdminAccount(input *DisassociateAdminAccountInput) (*DisassociateAdminAccountOutput, error)
DisassociateAdminAccount API operation for Firewall Management Service.
Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an AssociateAdminAccount request to set a new account as the AWS Firewall administrator.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation DisassociateAdminAccount for usage and error information.
Returned Error Codes:
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccount
func (*FMS) DisassociateAdminAccountRequest ¶
func (c *FMS) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) (req *request.Request, output *DisassociateAdminAccountOutput)
DisassociateAdminAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DisassociateAdminAccount for more information on using the DisassociateAdminAccount API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DisassociateAdminAccountRequest method. req, resp := client.DisassociateAdminAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccount
func (*FMS) DisassociateAdminAccountWithContext ¶
func (c *FMS) DisassociateAdminAccountWithContext(ctx aws.Context, input *DisassociateAdminAccountInput, opts ...request.Option) (*DisassociateAdminAccountOutput, error)
DisassociateAdminAccountWithContext is the same as DisassociateAdminAccount with the addition of the ability to pass a context and additional request options.
See DisassociateAdminAccount for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) GetAdminAccount ¶
func (c *FMS) GetAdminAccount(input *GetAdminAccountInput) (*GetAdminAccountOutput, error)
GetAdminAccount API operation for Firewall Management Service.
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation GetAdminAccount for usage and error information.
Returned Error Codes:
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccount
func (*FMS) GetAdminAccountRequest ¶
func (c *FMS) GetAdminAccountRequest(input *GetAdminAccountInput) (req *request.Request, output *GetAdminAccountOutput)
GetAdminAccountRequest generates a "aws/request.Request" representing the client's request for the GetAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetAdminAccount for more information on using the GetAdminAccount API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetAdminAccountRequest method. req, resp := client.GetAdminAccountRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccount
func (*FMS) GetAdminAccountWithContext ¶
func (c *FMS) GetAdminAccountWithContext(ctx aws.Context, input *GetAdminAccountInput, opts ...request.Option) (*GetAdminAccountOutput, error)
GetAdminAccountWithContext is the same as GetAdminAccount with the addition of the ability to pass a context and additional request options.
See GetAdminAccount for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) GetComplianceDetail ¶
func (c *FMS) GetComplianceDetail(input *GetComplianceDetailInput) (*GetComplianceDetailOutput, error)
GetComplianceDetail API operation for Firewall Management Service.
Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered non-compliant if the specified policy has not been applied to them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation GetComplianceDetail for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetail
func (*FMS) GetComplianceDetailRequest ¶
func (c *FMS) GetComplianceDetailRequest(input *GetComplianceDetailInput) (req *request.Request, output *GetComplianceDetailOutput)
GetComplianceDetailRequest generates a "aws/request.Request" representing the client's request for the GetComplianceDetail operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetComplianceDetail for more information on using the GetComplianceDetail API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetComplianceDetailRequest method. req, resp := client.GetComplianceDetailRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetail
func (*FMS) GetComplianceDetailWithContext ¶
func (c *FMS) GetComplianceDetailWithContext(ctx aws.Context, input *GetComplianceDetailInput, opts ...request.Option) (*GetComplianceDetailOutput, error)
GetComplianceDetailWithContext is the same as GetComplianceDetail with the addition of the ability to pass a context and additional request options.
See GetComplianceDetail for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) GetNotificationChannel ¶
func (c *FMS) GetNotificationChannel(input *GetNotificationChannelInput) (*GetNotificationChannelOutput, error)
GetNotificationChannel API operation for Firewall Management Service.
Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation GetNotificationChannel for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannel
func (*FMS) GetNotificationChannelRequest ¶
func (c *FMS) GetNotificationChannelRequest(input *GetNotificationChannelInput) (req *request.Request, output *GetNotificationChannelOutput)
GetNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the GetNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetNotificationChannel for more information on using the GetNotificationChannel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetNotificationChannelRequest method. req, resp := client.GetNotificationChannelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannel
func (*FMS) GetNotificationChannelWithContext ¶
func (c *FMS) GetNotificationChannelWithContext(ctx aws.Context, input *GetNotificationChannelInput, opts ...request.Option) (*GetNotificationChannelOutput, error)
GetNotificationChannelWithContext is the same as GetNotificationChannel with the addition of the ability to pass a context and additional request options.
See GetNotificationChannel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) GetPolicy ¶
func (c *FMS) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error)
GetPolicy API operation for Firewall Management Service.
Returns information about the specified AWS Firewall Manager policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation GetPolicy for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy
func (*FMS) GetPolicyRequest ¶
func (c *FMS) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, output *GetPolicyOutput)
GetPolicyRequest generates a "aws/request.Request" representing the client's request for the GetPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetPolicy for more information on using the GetPolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetPolicyRequest method. req, resp := client.GetPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy
func (*FMS) GetPolicyWithContext ¶
func (c *FMS) GetPolicyWithContext(ctx aws.Context, input *GetPolicyInput, opts ...request.Option) (*GetPolicyOutput, error)
GetPolicyWithContext is the same as GetPolicy with the addition of the ability to pass a context and additional request options.
See GetPolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) ListComplianceStatus ¶
func (c *FMS) ListComplianceStatus(input *ListComplianceStatusInput) (*ListComplianceStatusOutput, error)
ListComplianceStatus API operation for Firewall Management Service.
Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation ListComplianceStatus for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus
func (*FMS) ListComplianceStatusRequest ¶
func (c *FMS) ListComplianceStatusRequest(input *ListComplianceStatusInput) (req *request.Request, output *ListComplianceStatusOutput)
ListComplianceStatusRequest generates a "aws/request.Request" representing the client's request for the ListComplianceStatus operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListComplianceStatus for more information on using the ListComplianceStatus API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListComplianceStatusRequest method. req, resp := client.ListComplianceStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus
func (*FMS) ListComplianceStatusWithContext ¶
func (c *FMS) ListComplianceStatusWithContext(ctx aws.Context, input *ListComplianceStatusInput, opts ...request.Option) (*ListComplianceStatusOutput, error)
ListComplianceStatusWithContext is the same as ListComplianceStatus with the addition of the ability to pass a context and additional request options.
See ListComplianceStatus for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) ListPolicies ¶
func (c *FMS) ListPolicies(input *ListPoliciesInput) (*ListPoliciesOutput, error)
ListPolicies API operation for Firewall Management Service.
Returns an array of PolicySummary objects in the response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation ListPolicies for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeLimitExceededException "LimitExceededException" The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits (http://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the AWS WAF Developer Guide.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPolicies
func (*FMS) ListPoliciesRequest ¶
func (c *FMS) ListPoliciesRequest(input *ListPoliciesInput) (req *request.Request, output *ListPoliciesOutput)
ListPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListPolicies operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListPolicies for more information on using the ListPolicies API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListPoliciesRequest method. req, resp := client.ListPoliciesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPolicies
func (*FMS) ListPoliciesWithContext ¶
func (c *FMS) ListPoliciesWithContext(ctx aws.Context, input *ListPoliciesInput, opts ...request.Option) (*ListPoliciesOutput, error)
ListPoliciesWithContext is the same as ListPolicies with the addition of the ability to pass a context and additional request options.
See ListPolicies for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) PutNotificationChannel ¶
func (c *FMS) PutNotificationChannel(input *PutNotificationChannelInput) (*PutNotificationChannelOutput, error)
PutNotificationChannel API operation for Firewall Management Service.
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation PutNotificationChannel for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannel
func (*FMS) PutNotificationChannelRequest ¶
func (c *FMS) PutNotificationChannelRequest(input *PutNotificationChannelInput) (req *request.Request, output *PutNotificationChannelOutput)
PutNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the PutNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutNotificationChannel for more information on using the PutNotificationChannel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutNotificationChannelRequest method. req, resp := client.PutNotificationChannelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannel
func (*FMS) PutNotificationChannelWithContext ¶
func (c *FMS) PutNotificationChannelWithContext(ctx aws.Context, input *PutNotificationChannelInput, opts ...request.Option) (*PutNotificationChannelOutput, error)
PutNotificationChannelWithContext is the same as PutNotificationChannel with the addition of the ability to pass a context and additional request options.
See PutNotificationChannel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*FMS) PutPolicy ¶
func (c *FMS) PutPolicy(input *PutPolicyInput) (*PutPolicyOutput, error)
PutPolicy API operation for Firewall Management Service.
Creates an AWS Firewall Manager policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Firewall Management Service's API operation PutPolicy for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource was not found.
ErrCodeInvalidOperationException "InvalidOperationException" The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
ErrCodeInvalidInputException "InvalidInputException" The parameters of the request were invalid.
ErrCodeInternalErrorException "InternalErrorException" The operation failed because of a system problem, even though the request was valid. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicy
func (*FMS) PutPolicyRequest ¶
func (c *FMS) PutPolicyRequest(input *PutPolicyInput) (req *request.Request, output *PutPolicyOutput)
PutPolicyRequest generates a "aws/request.Request" representing the client's request for the PutPolicy operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutPolicy for more information on using the PutPolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutPolicyRequest method. req, resp := client.PutPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicy
func (*FMS) PutPolicyWithContext ¶
func (c *FMS) PutPolicyWithContext(ctx aws.Context, input *PutPolicyInput, opts ...request.Option) (*PutPolicyOutput, error)
PutPolicyWithContext is the same as PutPolicy with the addition of the ability to pass a context and additional request options.
See PutPolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type GetAdminAccountInput ¶
type GetAdminAccountInput struct {
// contains filtered or unexported fields
}
func (GetAdminAccountInput) GoString ¶
func (s GetAdminAccountInput) GoString() string
GoString returns the string representation
func (GetAdminAccountInput) String ¶
func (s GetAdminAccountInput) String() string
String returns the string representation
type GetAdminAccountOutput ¶
type GetAdminAccountOutput struct { // The AWS account that is set as the AWS Firewall Manager administrator. AdminAccount *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (GetAdminAccountOutput) GoString ¶
func (s GetAdminAccountOutput) GoString() string
GoString returns the string representation
func (*GetAdminAccountOutput) SetAdminAccount ¶
func (s *GetAdminAccountOutput) SetAdminAccount(v string) *GetAdminAccountOutput
SetAdminAccount sets the AdminAccount field's value.
func (GetAdminAccountOutput) String ¶
func (s GetAdminAccountOutput) String() string
String returns the string representation
type GetComplianceDetailInput ¶
type GetComplianceDetailInput struct { // The AWS account that owns the resources that you want to get the details // for. // // MemberAccount is a required field MemberAccount *string `min:"1" type:"string" required:"true"` // The ID of the policy that you want to get the details for. PolicyId is returned // by PutPolicy and by ListPolicies. // // PolicyId is a required field PolicyId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetComplianceDetailInput) GoString ¶
func (s GetComplianceDetailInput) GoString() string
GoString returns the string representation
func (*GetComplianceDetailInput) SetMemberAccount ¶
func (s *GetComplianceDetailInput) SetMemberAccount(v string) *GetComplianceDetailInput
SetMemberAccount sets the MemberAccount field's value.
func (*GetComplianceDetailInput) SetPolicyId ¶
func (s *GetComplianceDetailInput) SetPolicyId(v string) *GetComplianceDetailInput
SetPolicyId sets the PolicyId field's value.
func (GetComplianceDetailInput) String ¶
func (s GetComplianceDetailInput) String() string
String returns the string representation
func (*GetComplianceDetailInput) Validate ¶
func (s *GetComplianceDetailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetComplianceDetailOutput ¶
type GetComplianceDetailOutput struct { // Information about the resources and the policy that you specified in the // GetComplianceDetail request. PolicyComplianceDetail *PolicyComplianceDetail `type:"structure"` // contains filtered or unexported fields }
func (GetComplianceDetailOutput) GoString ¶
func (s GetComplianceDetailOutput) GoString() string
GoString returns the string representation
func (*GetComplianceDetailOutput) SetPolicyComplianceDetail ¶
func (s *GetComplianceDetailOutput) SetPolicyComplianceDetail(v *PolicyComplianceDetail) *GetComplianceDetailOutput
SetPolicyComplianceDetail sets the PolicyComplianceDetail field's value.
func (GetComplianceDetailOutput) String ¶
func (s GetComplianceDetailOutput) String() string
String returns the string representation
type GetNotificationChannelInput ¶
type GetNotificationChannelInput struct {
// contains filtered or unexported fields
}
func (GetNotificationChannelInput) GoString ¶
func (s GetNotificationChannelInput) GoString() string
GoString returns the string representation
func (GetNotificationChannelInput) String ¶
func (s GetNotificationChannelInput) String() string
String returns the string representation
type GetNotificationChannelOutput ¶
type GetNotificationChannelOutput struct { // The IAM role that is used by AWS Firewall Manager to record activity to SNS. SnsRoleName *string `min:"1" type:"string"` // The SNS topic that records AWS Firewall Manager activity. SnsTopicArn *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (GetNotificationChannelOutput) GoString ¶
func (s GetNotificationChannelOutput) GoString() string
GoString returns the string representation
func (*GetNotificationChannelOutput) SetSnsRoleName ¶
func (s *GetNotificationChannelOutput) SetSnsRoleName(v string) *GetNotificationChannelOutput
SetSnsRoleName sets the SnsRoleName field's value.
func (*GetNotificationChannelOutput) SetSnsTopicArn ¶
func (s *GetNotificationChannelOutput) SetSnsTopicArn(v string) *GetNotificationChannelOutput
SetSnsTopicArn sets the SnsTopicArn field's value.
func (GetNotificationChannelOutput) String ¶
func (s GetNotificationChannelOutput) String() string
String returns the string representation
type GetPolicyInput ¶
type GetPolicyInput struct { // The ID of the AWS Firewall Manager policy that you want the details for. // // PolicyId is a required field PolicyId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetPolicyInput) GoString ¶
func (s GetPolicyInput) GoString() string
GoString returns the string representation
func (*GetPolicyInput) SetPolicyId ¶
func (s *GetPolicyInput) SetPolicyId(v string) *GetPolicyInput
SetPolicyId sets the PolicyId field's value.
func (GetPolicyInput) String ¶
func (s GetPolicyInput) String() string
String returns the string representation
func (*GetPolicyInput) Validate ¶
func (s *GetPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPolicyOutput ¶
type GetPolicyOutput struct { // Information about the specified AWS Firewall Manager policy. Policy *Policy `type:"structure"` // The Amazon Resource Name (ARN) of the specified policy. PolicyArn *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (GetPolicyOutput) GoString ¶
func (s GetPolicyOutput) GoString() string
GoString returns the string representation
func (*GetPolicyOutput) SetPolicy ¶
func (s *GetPolicyOutput) SetPolicy(v *Policy) *GetPolicyOutput
SetPolicy sets the Policy field's value.
func (*GetPolicyOutput) SetPolicyArn ¶
func (s *GetPolicyOutput) SetPolicyArn(v string) *GetPolicyOutput
SetPolicyArn sets the PolicyArn field's value.
func (GetPolicyOutput) String ¶
func (s GetPolicyOutput) String() string
String returns the string representation
type ListComplianceStatusInput ¶
type ListComplianceStatusInput struct { // Specifies the number of PolicyComplianceStatus objects that you want AWS // Firewall Manager to return for this request. If you have more PolicyComplianceStatus // objects than the number that you specify for MaxResults, the response includes // a NextToken value that you can use to get another batch of PolicyComplianceStatus // objects. MaxResults *int64 `min:"1" type:"integer"` // If you specify a value for MaxResults and you have more PolicyComplianceStatus // objects than the number that you specify for MaxResults, AWS Firewall Manager // returns a NextToken value in the response that allows you to list another // group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus // requests, specify the value of NextToken from the previous response to get // information about another batch of PolicyComplianceStatus objects. NextToken *string `min:"1" type:"string"` // The ID of the AWS Firewall Manager policy that you want the details for. // // PolicyId is a required field PolicyId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListComplianceStatusInput) GoString ¶
func (s ListComplianceStatusInput) GoString() string
GoString returns the string representation
func (*ListComplianceStatusInput) SetMaxResults ¶
func (s *ListComplianceStatusInput) SetMaxResults(v int64) *ListComplianceStatusInput
SetMaxResults sets the MaxResults field's value.
func (*ListComplianceStatusInput) SetNextToken ¶
func (s *ListComplianceStatusInput) SetNextToken(v string) *ListComplianceStatusInput
SetNextToken sets the NextToken field's value.
func (*ListComplianceStatusInput) SetPolicyId ¶
func (s *ListComplianceStatusInput) SetPolicyId(v string) *ListComplianceStatusInput
SetPolicyId sets the PolicyId field's value.
func (ListComplianceStatusInput) String ¶
func (s ListComplianceStatusInput) String() string
String returns the string representation
func (*ListComplianceStatusInput) Validate ¶
func (s *ListComplianceStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListComplianceStatusOutput ¶
type ListComplianceStatusOutput struct { // If you have more PolicyComplianceStatus objects than the number that you // specified for MaxResults in the request, the response includes a NextToken // value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus // request, and specify the NextToken value from the response in the NextToken // value in the next request. NextToken *string `min:"1" type:"string"` // An array of PolicyComplianceStatus objects. PolicyComplianceStatusList []*PolicyComplianceStatus `type:"list"` // contains filtered or unexported fields }
func (ListComplianceStatusOutput) GoString ¶
func (s ListComplianceStatusOutput) GoString() string
GoString returns the string representation
func (*ListComplianceStatusOutput) SetNextToken ¶
func (s *ListComplianceStatusOutput) SetNextToken(v string) *ListComplianceStatusOutput
SetNextToken sets the NextToken field's value.
func (*ListComplianceStatusOutput) SetPolicyComplianceStatusList ¶
func (s *ListComplianceStatusOutput) SetPolicyComplianceStatusList(v []*PolicyComplianceStatus) *ListComplianceStatusOutput
SetPolicyComplianceStatusList sets the PolicyComplianceStatusList field's value.
func (ListComplianceStatusOutput) String ¶
func (s ListComplianceStatusOutput) String() string
String returns the string representation
type ListPoliciesInput ¶
type ListPoliciesInput struct { // Specifies the number of PolicySummary objects that you want AWS Firewall // Manager to return for this request. If you have more PolicySummary objects // than the number that you specify for MaxResults, the response includes a // NextToken value that you can use to get another batch of PolicySummary objects. MaxResults *int64 `min:"1" type:"integer"` // If you specify a value for MaxResults and you have more PolicySummary objects // than the number that you specify for MaxResults, AWS Firewall Manager returns // a NextToken value in the response that allows you to list another group of // PolicySummary objects. For the second and subsequent ListPolicies requests, // specify the value of NextToken from the previous response to get information // about another batch of PolicySummary objects. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListPoliciesInput) GoString ¶
func (s ListPoliciesInput) GoString() string
GoString returns the string representation
func (*ListPoliciesInput) SetMaxResults ¶
func (s *ListPoliciesInput) SetMaxResults(v int64) *ListPoliciesInput
SetMaxResults sets the MaxResults field's value.
func (*ListPoliciesInput) SetNextToken ¶
func (s *ListPoliciesInput) SetNextToken(v string) *ListPoliciesInput
SetNextToken sets the NextToken field's value.
func (ListPoliciesInput) String ¶
func (s ListPoliciesInput) String() string
String returns the string representation
func (*ListPoliciesInput) Validate ¶
func (s *ListPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPoliciesOutput ¶
type ListPoliciesOutput struct { // If you have more PolicySummary objects than the number that you specified // for MaxResults in the request, the response includes a NextToken value. To // list more PolicySummary objects, submit another ListPolicies request, and // specify the NextToken value from the response in the NextToken value in the // next request. NextToken *string `min:"1" type:"string"` // An array of PolicySummary objects. PolicyList []*PolicySummary `type:"list"` // contains filtered or unexported fields }
func (ListPoliciesOutput) GoString ¶
func (s ListPoliciesOutput) GoString() string
GoString returns the string representation
func (*ListPoliciesOutput) SetNextToken ¶
func (s *ListPoliciesOutput) SetNextToken(v string) *ListPoliciesOutput
SetNextToken sets the NextToken field's value.
func (*ListPoliciesOutput) SetPolicyList ¶
func (s *ListPoliciesOutput) SetPolicyList(v []*PolicySummary) *ListPoliciesOutput
SetPolicyList sets the PolicyList field's value.
func (ListPoliciesOutput) String ¶
func (s ListPoliciesOutput) String() string
String returns the string representation
type Policy ¶
type Policy struct { // If set to True, resources with the tags that are specified in the ResourceTag // array are not protected by the policy. If set to False, and the ResourceTag // array is not null, only resources with the specified tags are associated // with the policy. // // ExcludeResourceTags is a required field ExcludeResourceTags *bool `type:"boolean" required:"true"` // The ID of the AWS Firewall Manager policy. PolicyId *string `min:"36" type:"string"` // The friendly name of the AWS Firewall Manager policy. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // A unique identifier for each update to the policy. When issuing a PutPolicy // request, the PolicyUpdateToken in the request must match the PolicyUpdateToken // of the current policy version. To get the PolicyUpdateToken of the current // policy version, use a GetPolicy request. PolicyUpdateToken *string `min:"1" type:"string"` // Indicates if the policy should be automatically applied to new resources. // // RemediationEnabled is a required field RemediationEnabled *bool `type:"boolean" required:"true"` // An array of ResourceTag objects. ResourceTags []*ResourceTag `type:"list"` // The type of resource to protect with the policy, either an Application Load // Balancer or a CloudFront distribution. This is in the format shown in AWS // Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). // Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // Details about the security service that is being used to protect the resources. // // SecurityServicePolicyData is a required field SecurityServicePolicyData *SecurityServicePolicyData `type:"structure" required:"true"` // contains filtered or unexported fields }
An AWS Firewall Manager policy.
func (*Policy) SetExcludeResourceTags ¶
SetExcludeResourceTags sets the ExcludeResourceTags field's value.
func (*Policy) SetPolicyId ¶
SetPolicyId sets the PolicyId field's value.
func (*Policy) SetPolicyName ¶
SetPolicyName sets the PolicyName field's value.
func (*Policy) SetPolicyUpdateToken ¶
SetPolicyUpdateToken sets the PolicyUpdateToken field's value.
func (*Policy) SetRemediationEnabled ¶
SetRemediationEnabled sets the RemediationEnabled field's value.
func (*Policy) SetResourceTags ¶
func (s *Policy) SetResourceTags(v []*ResourceTag) *Policy
SetResourceTags sets the ResourceTags field's value.
func (*Policy) SetResourceType ¶
SetResourceType sets the ResourceType field's value.
func (*Policy) SetSecurityServicePolicyData ¶
func (s *Policy) SetSecurityServicePolicyData(v *SecurityServicePolicyData) *Policy
SetSecurityServicePolicyData sets the SecurityServicePolicyData field's value.
type PolicyComplianceDetail ¶
type PolicyComplianceDetail struct { // Indicates if over 100 resources are non-compliant with the AWS Firewall Manager // policy. EvaluationLimitExceeded *bool `type:"boolean"` // A time stamp that indicates when the returned information should be considered // out-of-date. ExpiredAt *time.Time `type:"timestamp"` // The AWS account ID. MemberAccount *string `min:"1" type:"string"` // The ID of the AWS Firewall Manager policy. PolicyId *string `min:"36" type:"string"` // The AWS account that created the AWS Firewall Manager policy. PolicyOwner *string `min:"1" type:"string"` // An array of resources that are not protected by the policy. Violators []*ComplianceViolator `type:"list"` // contains filtered or unexported fields }
Describes the non-compliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are non-compliant, EvaluationLimitExceeded is set to True.
func (PolicyComplianceDetail) GoString ¶
func (s PolicyComplianceDetail) GoString() string
GoString returns the string representation
func (*PolicyComplianceDetail) SetEvaluationLimitExceeded ¶
func (s *PolicyComplianceDetail) SetEvaluationLimitExceeded(v bool) *PolicyComplianceDetail
SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.
func (*PolicyComplianceDetail) SetExpiredAt ¶
func (s *PolicyComplianceDetail) SetExpiredAt(v time.Time) *PolicyComplianceDetail
SetExpiredAt sets the ExpiredAt field's value.
func (*PolicyComplianceDetail) SetMemberAccount ¶
func (s *PolicyComplianceDetail) SetMemberAccount(v string) *PolicyComplianceDetail
SetMemberAccount sets the MemberAccount field's value.
func (*PolicyComplianceDetail) SetPolicyId ¶
func (s *PolicyComplianceDetail) SetPolicyId(v string) *PolicyComplianceDetail
SetPolicyId sets the PolicyId field's value.
func (*PolicyComplianceDetail) SetPolicyOwner ¶
func (s *PolicyComplianceDetail) SetPolicyOwner(v string) *PolicyComplianceDetail
SetPolicyOwner sets the PolicyOwner field's value.
func (*PolicyComplianceDetail) SetViolators ¶
func (s *PolicyComplianceDetail) SetViolators(v []*ComplianceViolator) *PolicyComplianceDetail
SetViolators sets the Violators field's value.
func (PolicyComplianceDetail) String ¶
func (s PolicyComplianceDetail) String() string
String returns the string representation
type PolicyComplianceStatus ¶
type PolicyComplianceStatus struct { // An array of EvaluationResult objects. EvaluationResults []*EvaluationResult `type:"list"` // Time stamp of the last update to the EvaluationResult objects. LastUpdated *time.Time `type:"timestamp"` // The member account ID. MemberAccount *string `min:"1" type:"string"` // The ID of the AWS Firewall Manager policy. PolicyId *string `min:"36" type:"string"` // The friendly name of the AWS Firewall Manager policy. PolicyName *string `min:"1" type:"string"` // The AWS account that created the AWS Firewall Manager policy. PolicyOwner *string `min:"1" type:"string"` // contains filtered or unexported fields }
Indicates whether the account is compliant with the specified policy. An account is considered non-compliant if it includes resources that are not protected by the policy.
func (PolicyComplianceStatus) GoString ¶
func (s PolicyComplianceStatus) GoString() string
GoString returns the string representation
func (*PolicyComplianceStatus) SetEvaluationResults ¶
func (s *PolicyComplianceStatus) SetEvaluationResults(v []*EvaluationResult) *PolicyComplianceStatus
SetEvaluationResults sets the EvaluationResults field's value.
func (*PolicyComplianceStatus) SetLastUpdated ¶
func (s *PolicyComplianceStatus) SetLastUpdated(v time.Time) *PolicyComplianceStatus
SetLastUpdated sets the LastUpdated field's value.
func (*PolicyComplianceStatus) SetMemberAccount ¶
func (s *PolicyComplianceStatus) SetMemberAccount(v string) *PolicyComplianceStatus
SetMemberAccount sets the MemberAccount field's value.
func (*PolicyComplianceStatus) SetPolicyId ¶
func (s *PolicyComplianceStatus) SetPolicyId(v string) *PolicyComplianceStatus
SetPolicyId sets the PolicyId field's value.
func (*PolicyComplianceStatus) SetPolicyName ¶
func (s *PolicyComplianceStatus) SetPolicyName(v string) *PolicyComplianceStatus
SetPolicyName sets the PolicyName field's value.
func (*PolicyComplianceStatus) SetPolicyOwner ¶
func (s *PolicyComplianceStatus) SetPolicyOwner(v string) *PolicyComplianceStatus
SetPolicyOwner sets the PolicyOwner field's value.
func (PolicyComplianceStatus) String ¶
func (s PolicyComplianceStatus) String() string
String returns the string representation
type PolicySummary ¶
type PolicySummary struct { // The Amazon Resource Name (ARN) of the specified policy. PolicyArn *string `min:"1" type:"string"` // The ID of the specified policy. PolicyId *string `min:"36" type:"string"` // The friendly name of the specified policy. PolicyName *string `min:"1" type:"string"` // Indicates if the policy should be automatically applied to new resources. RemediationEnabled *bool `type:"boolean"` // The type of resource to protect with the policy, either an Application Load // Balancer or a CloudFront distribution. This is in the format shown in AWS // Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). // Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. ResourceType *string `min:"1" type:"string"` // The service that the policy is using to protect the resources. This value // is WAF. SecurityServiceType *string `type:"string" enum:"SecurityServiceType"` // contains filtered or unexported fields }
Details of the AWS Firewall Manager policy.
func (PolicySummary) GoString ¶
func (s PolicySummary) GoString() string
GoString returns the string representation
func (*PolicySummary) SetPolicyArn ¶
func (s *PolicySummary) SetPolicyArn(v string) *PolicySummary
SetPolicyArn sets the PolicyArn field's value.
func (*PolicySummary) SetPolicyId ¶
func (s *PolicySummary) SetPolicyId(v string) *PolicySummary
SetPolicyId sets the PolicyId field's value.
func (*PolicySummary) SetPolicyName ¶
func (s *PolicySummary) SetPolicyName(v string) *PolicySummary
SetPolicyName sets the PolicyName field's value.
func (*PolicySummary) SetRemediationEnabled ¶
func (s *PolicySummary) SetRemediationEnabled(v bool) *PolicySummary
SetRemediationEnabled sets the RemediationEnabled field's value.
func (*PolicySummary) SetResourceType ¶
func (s *PolicySummary) SetResourceType(v string) *PolicySummary
SetResourceType sets the ResourceType field's value.
func (*PolicySummary) SetSecurityServiceType ¶
func (s *PolicySummary) SetSecurityServiceType(v string) *PolicySummary
SetSecurityServiceType sets the SecurityServiceType field's value.
func (PolicySummary) String ¶
func (s PolicySummary) String() string
String returns the string representation
type PutNotificationChannelInput ¶
type PutNotificationChannelInput struct { // The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to // record AWS Firewall Manager activity. // // SnsRoleName is a required field SnsRoleName *string `min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the SNS topic that collects notifications // from AWS Firewall Manager. // // SnsTopicArn is a required field SnsTopicArn *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (PutNotificationChannelInput) GoString ¶
func (s PutNotificationChannelInput) GoString() string
GoString returns the string representation
func (*PutNotificationChannelInput) SetSnsRoleName ¶
func (s *PutNotificationChannelInput) SetSnsRoleName(v string) *PutNotificationChannelInput
SetSnsRoleName sets the SnsRoleName field's value.
func (*PutNotificationChannelInput) SetSnsTopicArn ¶
func (s *PutNotificationChannelInput) SetSnsTopicArn(v string) *PutNotificationChannelInput
SetSnsTopicArn sets the SnsTopicArn field's value.
func (PutNotificationChannelInput) String ¶
func (s PutNotificationChannelInput) String() string
String returns the string representation
func (*PutNotificationChannelInput) Validate ¶
func (s *PutNotificationChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutNotificationChannelOutput ¶
type PutNotificationChannelOutput struct {
// contains filtered or unexported fields
}
func (PutNotificationChannelOutput) GoString ¶
func (s PutNotificationChannelOutput) GoString() string
GoString returns the string representation
func (PutNotificationChannelOutput) String ¶
func (s PutNotificationChannelOutput) String() string
String returns the string representation
type PutPolicyInput ¶
type PutPolicyInput struct { // The details of the AWS Firewall Manager policy to be created. // // Policy is a required field Policy *Policy `type:"structure" required:"true"` // contains filtered or unexported fields }
func (PutPolicyInput) GoString ¶
func (s PutPolicyInput) GoString() string
GoString returns the string representation
func (*PutPolicyInput) SetPolicy ¶
func (s *PutPolicyInput) SetPolicy(v *Policy) *PutPolicyInput
SetPolicy sets the Policy field's value.
func (PutPolicyInput) String ¶
func (s PutPolicyInput) String() string
String returns the string representation
func (*PutPolicyInput) Validate ¶
func (s *PutPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutPolicyOutput ¶
type PutPolicyOutput struct { // The details of the AWS Firewall Manager policy that was created. Policy *Policy `type:"structure"` // The Amazon Resource Name (ARN) of the policy that was created. PolicyArn *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (PutPolicyOutput) GoString ¶
func (s PutPolicyOutput) GoString() string
GoString returns the string representation
func (*PutPolicyOutput) SetPolicy ¶
func (s *PutPolicyOutput) SetPolicy(v *Policy) *PutPolicyOutput
SetPolicy sets the Policy field's value.
func (*PutPolicyOutput) SetPolicyArn ¶
func (s *PutPolicyOutput) SetPolicyArn(v string) *PutPolicyOutput
SetPolicyArn sets the PolicyArn field's value.
func (PutPolicyOutput) String ¶
func (s PutPolicyOutput) String() string
String returns the string representation
type ResourceTag ¶
type ResourceTag struct { // The resource tag key. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The resource tag value. Value *string `type:"string"` // contains filtered or unexported fields }
The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from protection by the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. Tags are combined with an "OR." That is, if you add more than one tag, if any of the tags matches, the resource is considered a match for the include or exclude. Working with Tag Editor (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html).
func (ResourceTag) GoString ¶
func (s ResourceTag) GoString() string
GoString returns the string representation
func (*ResourceTag) SetKey ¶
func (s *ResourceTag) SetKey(v string) *ResourceTag
SetKey sets the Key field's value.
func (*ResourceTag) SetValue ¶
func (s *ResourceTag) SetValue(v string) *ResourceTag
SetValue sets the Value field's value.
func (ResourceTag) String ¶
func (s ResourceTag) String() string
String returns the string representation
func (*ResourceTag) Validate ¶
func (s *ResourceTag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SecurityServicePolicyData ¶
type SecurityServicePolicyData struct { // Details about the service. This contains WAF data in JSON format, as shown // in the following example: // // ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", // \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": // \"BLOCK\"}} ManagedServiceData *string `min:"1" type:"string"` // The service that the policy is using to protect the resources. This value // is WAF. // // Type is a required field Type *string `type:"string" required:"true" enum:"SecurityServiceType"` // contains filtered or unexported fields }
Details about the security service that is being used to protect the resources.
func (SecurityServicePolicyData) GoString ¶
func (s SecurityServicePolicyData) GoString() string
GoString returns the string representation
func (*SecurityServicePolicyData) SetManagedServiceData ¶
func (s *SecurityServicePolicyData) SetManagedServiceData(v string) *SecurityServicePolicyData
SetManagedServiceData sets the ManagedServiceData field's value.
func (*SecurityServicePolicyData) SetType ¶
func (s *SecurityServicePolicyData) SetType(v string) *SecurityServicePolicyData
SetType sets the Type field's value.
func (SecurityServicePolicyData) String ¶
func (s SecurityServicePolicyData) String() string
String returns the string representation
func (*SecurityServicePolicyData) Validate ¶
func (s *SecurityServicePolicyData) Validate() error
Validate inspects the fields of the type to determine if they are valid.