fms

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

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

View Source
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"
)
View Source
const (
	ServiceName = "fms"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccountRequest

func (AssociateAdminAccountInput) GoString

func (s AssociateAdminAccountInput) GoString() string

GoString returns the string representation

func (AssociateAdminAccountInput) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccountOutput

func (AssociateAdminAccountOutput) GoString

func (s AssociateAdminAccountOutput) GoString() string

GoString returns the string representation

func (AssociateAdminAccountOutput) SDKResponseMetadata

func (s AssociateAdminAccountOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (AssociateAdminAccountOutput) String

String returns the string representation

type AssociateAdminAccountRequest

type AssociateAdminAccountRequest struct {
	*aws.Request
	Input *AssociateAdminAccountInput
	Copy  func(*AssociateAdminAccountInput) AssociateAdminAccountRequest
}

AssociateAdminAccountRequest is a API request type for the AssociateAdminAccount API operation.

func (AssociateAdminAccountRequest) Send

Send marshals and sends the AssociateAdminAccount API request.

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 ViolationReason `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of the resource that is not protected by the policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ComplianceViolator

func (ComplianceViolator) GoString

func (s ComplianceViolator) GoString() string

GoString returns the string representation

func (ComplianceViolator) String

func (s ComplianceViolator) String() string

String returns the string representation

type DeleteNotificationChannelInput

type DeleteNotificationChannelInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannelRequest

func (DeleteNotificationChannelInput) GoString

GoString returns the string representation

func (DeleteNotificationChannelInput) String

String returns the string representation

type DeleteNotificationChannelOutput

type DeleteNotificationChannelOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannelOutput

func (DeleteNotificationChannelOutput) GoString

GoString returns the string representation

func (DeleteNotificationChannelOutput) SDKResponseMetadata

func (s DeleteNotificationChannelOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteNotificationChannelOutput) String

String returns the string representation

type DeleteNotificationChannelRequest

type DeleteNotificationChannelRequest struct {
	*aws.Request
	Input *DeleteNotificationChannelInput
	Copy  func(*DeleteNotificationChannelInput) DeleteNotificationChannelRequest
}

DeleteNotificationChannelRequest is a API request type for the DeleteNotificationChannel API operation.

func (DeleteNotificationChannelRequest) Send

Send marshals and sends the DeleteNotificationChannel API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicyRequest

func (DeletePolicyInput) GoString

func (s DeletePolicyInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicyOutput

func (DeletePolicyOutput) GoString

func (s DeletePolicyOutput) GoString() string

GoString returns the string representation

func (DeletePolicyOutput) SDKResponseMetadata

func (s DeletePolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeletePolicyOutput) String

func (s DeletePolicyOutput) String() string

String returns the string representation

type DeletePolicyRequest

type DeletePolicyRequest struct {
	*aws.Request
	Input *DeletePolicyInput
	Copy  func(*DeletePolicyInput) DeletePolicyRequest
}

DeletePolicyRequest is a API request type for the DeletePolicy API operation.

func (DeletePolicyRequest) Send

Send marshals and sends the DeletePolicy API request.

type DisassociateAdminAccountInput

type DisassociateAdminAccountInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccountRequest

func (DisassociateAdminAccountInput) GoString

GoString returns the string representation

func (DisassociateAdminAccountInput) String

String returns the string representation

type DisassociateAdminAccountOutput

type DisassociateAdminAccountOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccountOutput

func (DisassociateAdminAccountOutput) GoString

GoString returns the string representation

func (DisassociateAdminAccountOutput) SDKResponseMetadata

func (s DisassociateAdminAccountOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DisassociateAdminAccountOutput) String

String returns the string representation

type DisassociateAdminAccountRequest

type DisassociateAdminAccountRequest struct {
	*aws.Request
	Input *DisassociateAdminAccountInput
	Copy  func(*DisassociateAdminAccountInput) DisassociateAdminAccountRequest
}

DisassociateAdminAccountRequest is a API request type for the DisassociateAdminAccount API operation.

func (DisassociateAdminAccountRequest) Send

Send marshals and sends the DisassociateAdminAccount API request.

type EvaluationResult

type EvaluationResult struct {

	// Describes an AWS account's compliance with the AWS Firewall Manager policy.
	ComplianceStatus PolicyComplianceStatusType `type:"string" enum:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/EvaluationResult

func (EvaluationResult) GoString

func (s EvaluationResult) GoString() string

GoString returns the string representation

func (EvaluationResult) String

func (s EvaluationResult) String() string

String returns the string representation

type FMS

type FMS struct {
	*aws.Client
}

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(config aws.Config) *FMS

New creates a new instance of the FMS client with a config.

Example:

// Create a FMS client from just a config.
svc := fms.New(myConfig)

func (*FMS) AssociateAdminAccountRequest

func (c *FMS) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) AssociateAdminAccountRequest

AssociateAdminAccountRequest returns a request value for making 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.

// Example sending a request using the AssociateAdminAccountRequest method.
req := client.AssociateAdminAccountRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccount

func (*FMS) DeleteNotificationChannelRequest

func (c *FMS) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) DeleteNotificationChannelRequest

DeleteNotificationChannelRequest returns a request value for making 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.

// Example sending a request using the DeleteNotificationChannelRequest method.
req := client.DeleteNotificationChannelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannel

func (*FMS) DeletePolicyRequest

func (c *FMS) DeletePolicyRequest(input *DeletePolicyInput) DeletePolicyRequest

DeletePolicyRequest returns a request value for making API operation for Firewall Management Service.

Permanently deletes an AWS Firewall Manager policy.

// Example sending a request using the DeletePolicyRequest method.
req := client.DeletePolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicy

func (*FMS) DisassociateAdminAccountRequest

func (c *FMS) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) DisassociateAdminAccountRequest

DisassociateAdminAccountRequest returns a request value for making 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.

// Example sending a request using the DisassociateAdminAccountRequest method.
req := client.DisassociateAdminAccountRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccount

func (*FMS) GetAdminAccountRequest

func (c *FMS) GetAdminAccountRequest(input *GetAdminAccountInput) GetAdminAccountRequest

GetAdminAccountRequest returns a request value for making 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.

// Example sending a request using the GetAdminAccountRequest method.
req := client.GetAdminAccountRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccount

func (*FMS) GetComplianceDetailRequest

func (c *FMS) GetComplianceDetailRequest(input *GetComplianceDetailInput) GetComplianceDetailRequest

GetComplianceDetailRequest returns a request value for making 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.

// Example sending a request using the GetComplianceDetailRequest method.
req := client.GetComplianceDetailRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetail

func (*FMS) GetNotificationChannelRequest

func (c *FMS) GetNotificationChannelRequest(input *GetNotificationChannelInput) GetNotificationChannelRequest

GetNotificationChannelRequest returns a request value for making 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.

// Example sending a request using the GetNotificationChannelRequest method.
req := client.GetNotificationChannelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannel

func (*FMS) GetPolicyRequest

func (c *FMS) GetPolicyRequest(input *GetPolicyInput) GetPolicyRequest

GetPolicyRequest returns a request value for making API operation for Firewall Management Service.

Returns information about the specified AWS Firewall Manager policy.

// Example sending a request using the GetPolicyRequest method.
req := client.GetPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy

func (*FMS) ListComplianceStatusRequest

func (c *FMS) ListComplianceStatusRequest(input *ListComplianceStatusInput) ListComplianceStatusRequest

ListComplianceStatusRequest returns a request value for making 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.

// Example sending a request using the ListComplianceStatusRequest method.
req := client.ListComplianceStatusRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus

func (*FMS) ListPoliciesRequest

func (c *FMS) ListPoliciesRequest(input *ListPoliciesInput) ListPoliciesRequest

ListPoliciesRequest returns a request value for making API operation for Firewall Management Service.

Returns an array of PolicySummary objects in the response.

// Example sending a request using the ListPoliciesRequest method.
req := client.ListPoliciesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPolicies

func (*FMS) PutNotificationChannelRequest

func (c *FMS) PutNotificationChannelRequest(input *PutNotificationChannelInput) PutNotificationChannelRequest

PutNotificationChannelRequest returns a request value for making 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.

// Example sending a request using the PutNotificationChannelRequest method.
req := client.PutNotificationChannelRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannel

func (*FMS) PutPolicyRequest

func (c *FMS) PutPolicyRequest(input *PutPolicyInput) PutPolicyRequest

PutPolicyRequest returns a request value for making API operation for Firewall Management Service.

Creates an AWS Firewall Manager policy.

// Example sending a request using the PutPolicyRequest method.
req := client.PutPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicy

type GetAdminAccountInput

type GetAdminAccountInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccountRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccountResponse

func (GetAdminAccountOutput) GoString

func (s GetAdminAccountOutput) GoString() string

GoString returns the string representation

func (GetAdminAccountOutput) SDKResponseMetadata

func (s GetAdminAccountOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetAdminAccountOutput) String

func (s GetAdminAccountOutput) String() string

String returns the string representation

type GetAdminAccountRequest

type GetAdminAccountRequest struct {
	*aws.Request
	Input *GetAdminAccountInput
	Copy  func(*GetAdminAccountInput) GetAdminAccountRequest
}

GetAdminAccountRequest is a API request type for the GetAdminAccount API operation.

func (GetAdminAccountRequest) Send

Send marshals and sends the GetAdminAccount API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetailRequest

func (GetComplianceDetailInput) GoString

func (s GetComplianceDetailInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetailResponse

func (GetComplianceDetailOutput) GoString

func (s GetComplianceDetailOutput) GoString() string

GoString returns the string representation

func (GetComplianceDetailOutput) SDKResponseMetadata

func (s GetComplianceDetailOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetComplianceDetailOutput) String

func (s GetComplianceDetailOutput) String() string

String returns the string representation

type GetComplianceDetailRequest

type GetComplianceDetailRequest struct {
	*aws.Request
	Input *GetComplianceDetailInput
	Copy  func(*GetComplianceDetailInput) GetComplianceDetailRequest
}

GetComplianceDetailRequest is a API request type for the GetComplianceDetail API operation.

func (GetComplianceDetailRequest) Send

Send marshals and sends the GetComplianceDetail API request.

type GetNotificationChannelInput

type GetNotificationChannelInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannelRequest

func (GetNotificationChannelInput) GoString

func (s GetNotificationChannelInput) GoString() string

GoString returns the string representation

func (GetNotificationChannelInput) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannelResponse

func (GetNotificationChannelOutput) GoString

func (s GetNotificationChannelOutput) GoString() string

GoString returns the string representation

func (GetNotificationChannelOutput) SDKResponseMetadata

func (s GetNotificationChannelOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetNotificationChannelOutput) String

String returns the string representation

type GetNotificationChannelRequest

type GetNotificationChannelRequest struct {
	*aws.Request
	Input *GetNotificationChannelInput
	Copy  func(*GetNotificationChannelInput) GetNotificationChannelRequest
}

GetNotificationChannelRequest is a API request type for the GetNotificationChannel API operation.

func (GetNotificationChannelRequest) Send

Send marshals and sends the GetNotificationChannel API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicyRequest

func (GetPolicyInput) GoString

func (s GetPolicyInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicyResponse

func (GetPolicyOutput) GoString

func (s GetPolicyOutput) GoString() string

GoString returns the string representation

func (GetPolicyOutput) SDKResponseMetadata

func (s GetPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetPolicyOutput) String

func (s GetPolicyOutput) String() string

String returns the string representation

type GetPolicyRequest

type GetPolicyRequest struct {
	*aws.Request
	Input *GetPolicyInput
	Copy  func(*GetPolicyInput) GetPolicyRequest
}

GetPolicyRequest is a API request type for the GetPolicy API operation.

func (GetPolicyRequest) Send

func (r GetPolicyRequest) Send() (*GetPolicyOutput, error)

Send marshals and sends the GetPolicy API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatusRequest

func (ListComplianceStatusInput) GoString

func (s ListComplianceStatusInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatusResponse

func (ListComplianceStatusOutput) GoString

func (s ListComplianceStatusOutput) GoString() string

GoString returns the string representation

func (ListComplianceStatusOutput) SDKResponseMetadata

func (s ListComplianceStatusOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListComplianceStatusOutput) String

String returns the string representation

type ListComplianceStatusRequest

type ListComplianceStatusRequest struct {
	*aws.Request
	Input *ListComplianceStatusInput
	Copy  func(*ListComplianceStatusInput) ListComplianceStatusRequest
}

ListComplianceStatusRequest is a API request type for the ListComplianceStatus API operation.

func (ListComplianceStatusRequest) Send

Send marshals and sends the ListComplianceStatus API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPoliciesRequest

func (ListPoliciesInput) GoString

func (s ListPoliciesInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPoliciesResponse

func (ListPoliciesOutput) GoString

func (s ListPoliciesOutput) GoString() string

GoString returns the string representation

func (ListPoliciesOutput) SDKResponseMetadata

func (s ListPoliciesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListPoliciesOutput) String

func (s ListPoliciesOutput) String() string

String returns the string representation

type ListPoliciesRequest

type ListPoliciesRequest struct {
	*aws.Request
	Input *ListPoliciesInput
	Copy  func(*ListPoliciesInput) ListPoliciesRequest
}

ListPoliciesRequest is a API request type for the ListPolicies API operation.

func (ListPoliciesRequest) Send

Send marshals and sends the ListPolicies API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/Policy

func (Policy) GoString

func (s Policy) GoString() string

GoString returns the string representation

func (Policy) String

func (s Policy) String() string

String returns the string representation

func (*Policy) Validate

func (s *Policy) Validate() error

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

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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicyComplianceDetail

func (PolicyComplianceDetail) GoString

func (s PolicyComplianceDetail) GoString() string

GoString returns the string representation

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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicyComplianceStatus

func (PolicyComplianceStatus) GoString

func (s PolicyComplianceStatus) GoString() string

GoString returns the string representation

func (PolicyComplianceStatus) String

func (s PolicyComplianceStatus) String() string

String returns the string representation

type PolicyComplianceStatusType

type PolicyComplianceStatusType string
const (
	PolicyComplianceStatusTypeCompliant    PolicyComplianceStatusType = "COMPLIANT"
	PolicyComplianceStatusTypeNonCompliant PolicyComplianceStatusType = "NON_COMPLIANT"
)

Enum values for PolicyComplianceStatusType

func (PolicyComplianceStatusType) MarshalValue

func (enum PolicyComplianceStatusType) MarshalValue() (string, error)

func (PolicyComplianceStatusType) MarshalValueBuf

func (enum PolicyComplianceStatusType) MarshalValueBuf(b []byte) ([]byte, error)

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 SecurityServiceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of the AWS Firewall Manager policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicySummary

func (PolicySummary) GoString

func (s PolicySummary) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannelRequest

func (PutNotificationChannelInput) GoString

func (s PutNotificationChannelInput) GoString() string

GoString returns the string representation

func (PutNotificationChannelInput) 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannelOutput

func (PutNotificationChannelOutput) GoString

func (s PutNotificationChannelOutput) GoString() string

GoString returns the string representation

func (PutNotificationChannelOutput) SDKResponseMetadata

func (s PutNotificationChannelOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutNotificationChannelOutput) String

String returns the string representation

type PutNotificationChannelRequest

type PutNotificationChannelRequest struct {
	*aws.Request
	Input *PutNotificationChannelInput
	Copy  func(*PutNotificationChannelInput) PutNotificationChannelRequest
}

PutNotificationChannelRequest is a API request type for the PutNotificationChannel API operation.

func (PutNotificationChannelRequest) Send

Send marshals and sends the PutNotificationChannel API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicyRequest

func (PutPolicyInput) GoString

func (s PutPolicyInput) GoString() string

GoString returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicyResponse

func (PutPolicyOutput) GoString

func (s PutPolicyOutput) GoString() string

GoString returns the string representation

func (PutPolicyOutput) SDKResponseMetadata

func (s PutPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutPolicyOutput) String

func (s PutPolicyOutput) String() string

String returns the string representation

type PutPolicyRequest

type PutPolicyRequest struct {
	*aws.Request
	Input *PutPolicyInput
	Copy  func(*PutPolicyInput) PutPolicyRequest
}

PutPolicyRequest is a API request type for the PutPolicy API operation.

func (PutPolicyRequest) Send

func (r PutPolicyRequest) Send() (*PutPolicyOutput, error)

Send marshals and sends the PutPolicy API request.

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). Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ResourceTag

func (ResourceTag) GoString

func (s ResourceTag) GoString() string

GoString returns the string representation

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 SecurityServiceType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Details about the security service that is being used to protect the resources. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/SecurityServicePolicyData

func (SecurityServicePolicyData) GoString

func (s SecurityServicePolicyData) GoString() string

GoString returns the string representation

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.

type SecurityServiceType

type SecurityServiceType string
const (
	SecurityServiceTypeWaf SecurityServiceType = "WAF"
)

Enum values for SecurityServiceType

func (SecurityServiceType) MarshalValue

func (enum SecurityServiceType) MarshalValue() (string, error)

func (SecurityServiceType) MarshalValueBuf

func (enum SecurityServiceType) MarshalValueBuf(b []byte) ([]byte, error)

type ViolationReason

type ViolationReason string
const (
	ViolationReasonWebAclMissingRuleGroup  ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"
	ViolationReasonResourceMissingWebAcl   ViolationReason = "RESOURCE_MISSING_WEB_ACL"
	ViolationReasonResourceIncorrectWebAcl ViolationReason = "RESOURCE_INCORRECT_WEB_ACL"
)

Enum values for ViolationReason

func (ViolationReason) MarshalValue

func (enum ViolationReason) MarshalValue() (string, error)

func (ViolationReason) MarshalValueBuf

func (enum ViolationReason) MarshalValueBuf(b []byte) ([]byte, error)

Directories

Path Synopsis
Package fmsiface provides an interface to enable mocking the Firewall Management Service service client for testing your code.
Package fmsiface provides an interface to enable mocking the Firewall Management Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL