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 (https://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
- type AccountRoleStatus
- type AssociateAdminAccountInput
- type AssociateAdminAccountOutput
- type AssociateAdminAccountRequest
- type ComplianceViolator
- type CustomerPolicyScopeIdType
- type DeleteNotificationChannelInput
- type DeleteNotificationChannelOutput
- type DeleteNotificationChannelRequest
- type DeletePolicyInput
- type DeletePolicyOutput
- type DeletePolicyRequest
- type DependentServiceName
- type DisassociateAdminAccountInput
- type DisassociateAdminAccountOutput
- type DisassociateAdminAccountRequest
- type EvaluationResult
- type FMS
- func (c *FMS) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) AssociateAdminAccountRequest
- func (c *FMS) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) DeleteNotificationChannelRequest
- func (c *FMS) DeletePolicyRequest(input *DeletePolicyInput) DeletePolicyRequest
- func (c *FMS) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) DisassociateAdminAccountRequest
- func (c *FMS) GetAdminAccountRequest(input *GetAdminAccountInput) GetAdminAccountRequest
- func (c *FMS) GetComplianceDetailRequest(input *GetComplianceDetailInput) GetComplianceDetailRequest
- func (c *FMS) GetNotificationChannelRequest(input *GetNotificationChannelInput) GetNotificationChannelRequest
- func (c *FMS) GetPolicyRequest(input *GetPolicyInput) GetPolicyRequest
- func (c *FMS) GetProtectionStatusRequest(input *GetProtectionStatusInput) GetProtectionStatusRequest
- func (c *FMS) ListComplianceStatusRequest(input *ListComplianceStatusInput) ListComplianceStatusRequest
- func (c *FMS) ListMemberAccountsRequest(input *ListMemberAccountsInput) ListMemberAccountsRequest
- func (c *FMS) ListPoliciesRequest(input *ListPoliciesInput) ListPoliciesRequest
- func (c *FMS) PutNotificationChannelRequest(input *PutNotificationChannelInput) PutNotificationChannelRequest
- func (c *FMS) PutPolicyRequest(input *PutPolicyInput) PutPolicyRequest
- type GetAdminAccountInput
- type GetAdminAccountOutput
- type GetAdminAccountRequest
- type GetComplianceDetailInput
- type GetComplianceDetailOutput
- type GetComplianceDetailRequest
- type GetNotificationChannelInput
- type GetNotificationChannelOutput
- type GetNotificationChannelRequest
- type GetPolicyInput
- type GetPolicyOutput
- type GetPolicyRequest
- type GetProtectionStatusInput
- type GetProtectionStatusOutput
- type GetProtectionStatusRequest
- type ListComplianceStatusInput
- type ListComplianceStatusOutput
- type ListComplianceStatusPager
- type ListComplianceStatusRequest
- type ListMemberAccountsInput
- type ListMemberAccountsOutput
- type ListMemberAccountsPager
- type ListMemberAccountsRequest
- type ListPoliciesInput
- type ListPoliciesOutput
- type ListPoliciesPager
- type ListPoliciesRequest
- type Policy
- type PolicyComplianceDetail
- type PolicyComplianceStatus
- type PolicyComplianceStatusType
- type PolicySummary
- type PutNotificationChannelInput
- type PutNotificationChannelOutput
- type PutNotificationChannelRequest
- type PutPolicyInput
- type PutPolicyOutput
- type PutPolicyRequest
- type ResourceTag
- type SecurityServicePolicyData
- type SecurityServiceType
- type ViolationReason
Constants ¶
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" // ErrCodeInvalidTypeException for service response error code // "InvalidTypeException". // // The value of the Type parameter is invalid. ErrCodeInvalidTypeException = "InvalidTypeException" // 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 (https://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" // 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 AccountRoleStatus ¶ added in v0.5.0
type AccountRoleStatus string
const ( AccountRoleStatusReady AccountRoleStatus = "READY" AccountRoleStatusCreating AccountRoleStatus = "CREATING" AccountRoleStatusPendingDeletion AccountRoleStatus = "PENDING_DELETION" AccountRoleStatusDeleting AccountRoleStatus = "DELETING" AccountRoleStatusDeleted AccountRoleStatus = "DELETED" )
Enum values for AccountRoleStatus
func (AccountRoleStatus) MarshalValue ¶ added in v0.5.0
func (enum AccountRoleStatus) MarshalValue() (string, error)
func (AccountRoleStatus) MarshalValueBuf ¶ added in v0.5.0
func (enum AccountRoleStatus) MarshalValueBuf(b []byte) ([]byte, error)
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 ¶
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
}
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 ¶
func (s AssociateAdminAccountOutput) String() 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 ¶
func (r AssociateAdminAccountRequest) Send(ctx context.Context) (*AssociateAdminAccountOutput, error)
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). // For example: 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 CustomerPolicyScopeIdType ¶ added in v0.5.0
type CustomerPolicyScopeIdType string
const (
CustomerPolicyScopeIdTypeAccount CustomerPolicyScopeIdType = "ACCOUNT"
)
Enum values for CustomerPolicyScopeIdType
func (CustomerPolicyScopeIdType) MarshalValue ¶ added in v0.5.0
func (enum CustomerPolicyScopeIdType) MarshalValue() (string, error)
func (CustomerPolicyScopeIdType) MarshalValueBuf ¶ added in v0.5.0
func (enum CustomerPolicyScopeIdType) MarshalValueBuf(b []byte) ([]byte, error)
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 ¶
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannelOutput
func (DeleteNotificationChannelOutput) GoString ¶
func (s DeleteNotificationChannelOutput) GoString() string
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 ¶
func (s DeleteNotificationChannelOutput) String() 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 ¶
func (r DeleteNotificationChannelRequest) Send(ctx context.Context) (*DeleteNotificationChannelOutput, error)
Send marshals and sends the DeleteNotificationChannel API request.
type DeletePolicyInput ¶
type DeletePolicyInput struct { // If True, the request will also perform a clean-up process that will: // // * Delete rule groups created by AWS Firewall Manager // // * Remove web ACLs from in-scope resources // // * Delete web ACLs that contain no rules or rule groups // // After the cleanup, in-scope resources will no longer be protected by web // ACLs in this policy. Protection of out-of-scope resources will remain unchanged. // Scope is determined by tags and accounts associated with the policy. When // creating the policy, if you specified that only resources in specific accounts // or with specific tags be protected by the policy, those resources are in-scope. // All others are out of scope. If you did not specify tags or accounts, all // resources are in-scope. DeleteAllPolicyResources *bool `type:"boolean"` // 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 ¶
func (r DeletePolicyRequest) Send(ctx context.Context) (*DeletePolicyOutput, error)
Send marshals and sends the DeletePolicy API request.
type DependentServiceName ¶ added in v0.5.0
type DependentServiceName string
const ( DependentServiceNameAwsconfig DependentServiceName = "AWSCONFIG" DependentServiceNameAwswaf DependentServiceName = "AWSWAF" DependentServiceNameAwsshieldAdvanced DependentServiceName = "AWSSHIELD_ADVANCED" )
Enum values for DependentServiceName
func (DependentServiceName) MarshalValue ¶ added in v0.5.0
func (enum DependentServiceName) MarshalValue() (string, error)
func (DependentServiceName) MarshalValueBuf ¶ added in v0.5.0
func (enum DependentServiceName) MarshalValueBuf(b []byte) ([]byte, error)
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 ¶
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
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccountOutput
func (DisassociateAdminAccountOutput) GoString ¶
func (s DisassociateAdminAccountOutput) GoString() string
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 ¶
func (s DisassociateAdminAccountOutput) String() 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 ¶
func (r DisassociateAdminAccountRequest) Send(ctx context.Context) (*DisassociateAdminAccountOutput, error)
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 ¶
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 ¶
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 the master account your AWS organization 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(context.TODO()) 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(context.TODO()) 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(context.TODO()) 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. To set a different account as the administrator account, you must submit an AssociateAdminAccount request .
// Example sending a request using the DisassociateAdminAccountRequest method. req := client.DisassociateAdminAccountRequest(params) resp, err := req.Send(context.TODO()) 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(context.TODO()) 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(context.TODO()) 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(context.TODO()) 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(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy
func (*FMS) GetProtectionStatusRequest ¶ added in v0.8.0
func (c *FMS) GetProtectionStatusRequest(input *GetProtectionStatusInput) GetProtectionStatusRequest
GetProtectionStatusRequest returns a request value for making API operation for Firewall Management Service.
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
// Example sending a request using the GetProtectionStatusRequest method. req := client.GetProtectionStatusRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatus
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(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus
func (*FMS) ListMemberAccountsRequest ¶ added in v0.5.0
func (c *FMS) ListMemberAccountsRequest(input *ListMemberAccountsInput) ListMemberAccountsRequest
ListMemberAccountsRequest returns a request value for making API operation for Firewall Management Service.
Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator.
// Example sending a request using the ListMemberAccountsRequest method. req := client.ListMemberAccountsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListMemberAccounts
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(context.TODO()) 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(context.TODO()) 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.
Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on subscribing to Shield Advanced, see CreateSubscription (https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html).
// Example sending a request using the PutPolicyRequest method. req := client.PutPolicyRequest(params) resp, err := req.Send(context.TODO()) 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"` // The status of the AWS account that you set as the AWS Firewall Manager administrator. RoleStatus AccountRoleStatus `type:"string" enum:"true"` // 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 ¶
func (r GetAdminAccountRequest) Send(ctx context.Context) (*GetAdminAccountOutput, error)
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 ¶
func (r GetComplianceDetailRequest) Send(ctx context.Context) (*GetComplianceDetailOutput, error)
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 ¶
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 }
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 ¶
func (s GetNotificationChannelOutput) String() 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 ¶
func (r GetNotificationChannelRequest) Send(ctx context.Context) (*GetNotificationChannelOutput, error)
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(ctx context.Context) (*GetPolicyOutput, error)
Send marshals and sends the GetPolicy API request.
type GetProtectionStatusInput ¶ added in v0.8.0
type GetProtectionStatusInput struct { // The end of the time period to query for the attacks. This is a timestamp // type. The sample request above indicates a number type because the default // used by AWS Firewall Manager is Unix time in seconds. However, any valid // timestamp format is allowed. EndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Specifies the number of objects that you want AWS Firewall Manager to return // for this request. If you have more objects than the number that you specify // for MaxResults, the response includes a NextToken value that you can use // to get another batch of objects. MaxResults *int64 `min:"1" type:"integer"` // The AWS account that is in scope of the policy that you want to get the details // for. MemberAccountId *string `min:"1" type:"string"` // If you specify a value for MaxResults and you have more 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 objects. For // the second and subsequent GetProtectionStatus requests, specify the value // of NextToken from the previous response to get information about another // batch of objects. NextToken *string `min:"1" type:"string"` // The ID of the policy for which you want to get the attack information. // // PolicyId is a required field PolicyId *string `min:"36" type:"string" required:"true"` // The start of the time period to query for the attacks. This is a timestamp // type. The sample request above indicates a number type because the default // used by AWS Firewall Manager is Unix time in seconds. However, any valid // timestamp format is allowed. StartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatusRequest
func (GetProtectionStatusInput) GoString ¶ added in v0.8.0
func (s GetProtectionStatusInput) GoString() string
GoString returns the string representation
func (GetProtectionStatusInput) String ¶ added in v0.8.0
func (s GetProtectionStatusInput) String() string
String returns the string representation
func (*GetProtectionStatusInput) Validate ¶ added in v0.8.0
func (s *GetProtectionStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetProtectionStatusOutput ¶ added in v0.8.0
type GetProtectionStatusOutput struct { // The ID of the AWS Firewall administrator account for this policy. AdminAccountId *string `min:"1" type:"string"` // Details about the attack, including the following: // // * Attack type // // * Account ID // // * ARN of the resource attacked // // * Start time of the attack // // * End time of the attack (ongoing attacks will not have an end time) // // The details are in JSON format. An example is shown in the Examples section // below. Data *string `type:"string"` // If you have more objects than the number that you specified for MaxResults // in the request, the response includes a NextToken value. To list more objects, // submit another GetProtectionStatus request, and specify the NextToken value // from the response in the NextToken value in the next request. // // AWS SDKs provide auto-pagination that identify NextToken in a response and // make subsequent request calls automatically on your behalf. However, this // feature is not supported by GetProtectionStatus. You must submit subsequent // requests with NextToken using your own processes. NextToken *string `min:"1" type:"string"` // The service type that is protected by the policy. Currently, this is always // SHIELD_ADVANCED. ServiceType SecurityServiceType `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatusResponse
func (GetProtectionStatusOutput) GoString ¶ added in v0.8.0
func (s GetProtectionStatusOutput) GoString() string
GoString returns the string representation
func (GetProtectionStatusOutput) SDKResponseMetadata ¶ added in v0.8.0
func (s GetProtectionStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetProtectionStatusOutput) String ¶ added in v0.8.0
func (s GetProtectionStatusOutput) String() string
String returns the string representation
type GetProtectionStatusRequest ¶ added in v0.8.0
type GetProtectionStatusRequest struct { *aws.Request Input *GetProtectionStatusInput Copy func(*GetProtectionStatusInput) GetProtectionStatusRequest }
GetProtectionStatusRequest is a API request type for the GetProtectionStatus API operation.
func (GetProtectionStatusRequest) Send ¶ added in v0.8.0
func (r GetProtectionStatusRequest) Send(ctx context.Context) (*GetProtectionStatusOutput, error)
Send marshals and sends the GetProtectionStatus 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 ¶
func (s ListComplianceStatusOutput) String() string
String returns the string representation
type ListComplianceStatusPager ¶ added in v0.8.0
ListComplianceStatusPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListComplianceStatusPager) CurrentPage ¶ added in v0.8.0
func (p *ListComplianceStatusPager) CurrentPage() *ListComplianceStatusOutput
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) Paginate ¶ added in v0.8.0
func (p *ListComplianceStatusRequest) Paginate(opts ...aws.Option) ListComplianceStatusPager
Paginate pages iterates over the pages of a ListComplianceStatusRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListComplianceStatus operation. req := client.ListComplianceStatusRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListComplianceStatusRequest) Send ¶
func (r ListComplianceStatusRequest) Send(ctx context.Context) (*ListComplianceStatusOutput, error)
Send marshals and sends the ListComplianceStatus API request.
type ListMemberAccountsInput ¶ added in v0.5.0
type ListMemberAccountsInput struct { // Specifies the number of member account IDs that you want AWS Firewall Manager // to return for this request. If you have more IDs than the number that you // specify for MaxResults, the response includes a NextToken value that you // can use to get another batch of member account IDs. MaxResults *int64 `min:"1" type:"integer"` // If you specify a value for MaxResults and you have more account IDs 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 // IDs. For the second and subsequent ListMemberAccountsRequest requests, specify // the value of NextToken from the previous response to get information about // another batch of member account IDs. 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/ListMemberAccountsRequest
func (ListMemberAccountsInput) GoString ¶ added in v0.5.0
func (s ListMemberAccountsInput) GoString() string
GoString returns the string representation
func (ListMemberAccountsInput) String ¶ added in v0.5.0
func (s ListMemberAccountsInput) String() string
String returns the string representation
func (*ListMemberAccountsInput) Validate ¶ added in v0.5.0
func (s *ListMemberAccountsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListMemberAccountsOutput ¶ added in v0.5.0
type ListMemberAccountsOutput struct { // An array of account IDs. MemberAccounts []string `type:"list"` // If you have more member account IDs than the number that you specified for // MaxResults in the request, the response includes a NextToken value. To list // more IDs, submit another ListMemberAccounts request, and specify the NextToken // value from the response in the NextToken value in the next request. 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/ListMemberAccountsResponse
func (ListMemberAccountsOutput) GoString ¶ added in v0.5.0
func (s ListMemberAccountsOutput) GoString() string
GoString returns the string representation
func (ListMemberAccountsOutput) SDKResponseMetadata ¶ added in v0.5.0
func (s ListMemberAccountsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListMemberAccountsOutput) String ¶ added in v0.5.0
func (s ListMemberAccountsOutput) String() string
String returns the string representation
type ListMemberAccountsPager ¶ added in v0.8.0
ListMemberAccountsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListMemberAccountsPager) CurrentPage ¶ added in v0.8.0
func (p *ListMemberAccountsPager) CurrentPage() *ListMemberAccountsOutput
type ListMemberAccountsRequest ¶ added in v0.5.0
type ListMemberAccountsRequest struct { *aws.Request Input *ListMemberAccountsInput Copy func(*ListMemberAccountsInput) ListMemberAccountsRequest }
ListMemberAccountsRequest is a API request type for the ListMemberAccounts API operation.
func (*ListMemberAccountsRequest) Paginate ¶ added in v0.8.0
func (p *ListMemberAccountsRequest) Paginate(opts ...aws.Option) ListMemberAccountsPager
Paginate pages iterates over the pages of a ListMemberAccountsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListMemberAccounts operation. req := client.ListMemberAccountsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListMemberAccountsRequest) Send ¶ added in v0.5.0
func (r ListMemberAccountsRequest) Send(ctx context.Context) (*ListMemberAccountsOutput, error)
Send marshals and sends the ListMemberAccounts 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 ListPoliciesPager ¶ added in v0.8.0
ListPoliciesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListPoliciesPager) CurrentPage ¶ added in v0.8.0
func (p *ListPoliciesPager) CurrentPage() *ListPoliciesOutput
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) Paginate ¶ added in v0.8.0
func (p *ListPoliciesRequest) Paginate(opts ...aws.Option) ListPoliciesPager
Paginate pages iterates over the pages of a ListPoliciesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListPolicies operation. req := client.ListPoliciesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListPoliciesRequest) Send ¶
func (r ListPoliciesRequest) Send(ctx context.Context) (*ListPoliciesOutput, error)
Send marshals and sends the ListPolicies API request.
type Policy ¶
type Policy struct { // Specifies the AWS account IDs to exclude from the policy. The IncludeMap // values are evaluated first, with all the appropriate account IDs added to // the policy. Then the accounts listed in ExcludeMap are removed, resulting // in the final list of accounts to add to the policy. // // The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” // : [“accountID1”, “accountID2”]}. ExcludeMap map[string][]string `type:"map"` // 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"` // Specifies the AWS account IDs to include in the policy. If IncludeMap is // null, all accounts in the organization in AWS Organizations are included // in the policy. If IncludeMap is not null, only values listed in IncludeMap // are included in the policy. // // The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” // : [“accountID1”, “accountID2”]}. IncludeMap map[string][]string `type:"map"` // 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. 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). // For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution. // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // An array of ResourceType. ResourceTypeList []string `type:"list"` // 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
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"` // Details about problems with dependent services, such as AWS WAF or AWS Config, // that are causing a resource to be non-compliant. The details include the // name of the dependent service and the error message received that indicates // the problem with the service. IssueInfoMap map[string]string `type:"map"` // 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"` // Details about problems with dependent services, such as AWS WAF or AWS Config, // that are causing a resource to be non-compliant. The details include the // name of the dependent service and the error message received that indicates // the problem with the service. IssueInfoMap map[string]string `type:"map"` // 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. 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). // For example: 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 specifies // the type of policy that is created, either a WAF policy or Shield Advanced // policy. 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 ¶
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
}
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 ¶
func (s PutNotificationChannelOutput) String() 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 ¶
func (r PutNotificationChannelRequest) Send(ctx context.Context) (*PutNotificationChannelOutput, error)
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(ctx context.Context) (*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\"}} // // If this is a Shield Advanced policy, this string will be empty. ManagedServiceData *string `min:"1" type:"string"` // The service that the policy is using to protect the resources. This specifies // the type of policy that is created, either a WAF policy or Shield Advanced // policy. // // 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" SecurityServiceTypeShieldAdvanced SecurityServiceType = "SHIELD_ADVANCED" )
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" ViolationReasonResourceMissingShieldProtection ViolationReason = "RESOURCE_MISSING_SHIELD_PROTECTION" )
Enum values for ViolationReason
func (ViolationReason) MarshalValue ¶
func (enum ViolationReason) MarshalValue() (string, error)
func (ViolationReason) MarshalValueBuf ¶
func (enum ViolationReason) MarshalValueBuf(b []byte) ([]byte, error)