fms

package module
v1.24.3 Latest Latest
Warning

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

Go to latest
Published: Jun 15, 2023 License: Apache-2.0 Imports: 33 Imported by: 15

Documentation

Overview

Package fms provides the API client, operations, and parameter types for Firewall Management Service.

This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html) . Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager (https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service) .

Index

Constants

View Source
const ServiceAPIVersion = "2018-01-01"
View Source
const ServiceID = "FMS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateAdminAccountInput

type AssociateAdminAccountInput struct {

	// The Amazon Web Services account ID to associate with Firewall Manager as the
	// Firewall Manager default administrator account. This account must be a member
	// account of the organization in Organizations whose resources you want to
	// protect. For more information about Organizations, see Managing the Amazon Web
	// Services Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html)
	// .
	//
	// This member is required.
	AdminAccount *string
	// contains filtered or unexported fields
}

type AssociateAdminAccountOutput

type AssociateAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateThirdPartyFirewallInput added in v1.17.0

type AssociateThirdPartyFirewallInput struct {

	// The name of the third-party firewall vendor.
	//
	// This member is required.
	ThirdPartyFirewall types.ThirdPartyFirewall
	// contains filtered or unexported fields
}

type AssociateThirdPartyFirewallOutput added in v1.17.0

type AssociateThirdPartyFirewallOutput struct {

	// The current status for setting a Firewall Manager policy administrator's
	// account as an administrator of the third-party firewall tenant.
	//   - ONBOARDING - The Firewall Manager policy administrator is being designated
	//   as a tenant administrator.
	//   - ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated
	//   as a tenant administrator.
	//   - OFFBOARDING - The Firewall Manager policy administrator is being removed as
	//   a tenant administrator.
	//   - OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been
	//   removed as a tenant administrator.
	//   - NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a
	//   tenant administrator.
	ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchAssociateResourceInput added in v1.20.0

type BatchAssociateResourceInput struct {

	// The uniform resource identifiers (URIs) of resources that should be associated
	// to the resource set. The URIs must be Amazon Resource Names (ARNs).
	//
	// This member is required.
	Items []string

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	ResourceSetIdentifier *string
	// contains filtered or unexported fields
}

type BatchAssociateResourceOutput added in v1.20.0

type BatchAssociateResourceOutput struct {

	// The resources that failed to associate to the resource set.
	//
	// This member is required.
	FailedItems []types.FailedItem

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	ResourceSetIdentifier *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchDisassociateResourceInput added in v1.20.0

type BatchDisassociateResourceInput struct {

	// The uniform resource identifiers (URI) of resources that should be
	// disassociated from the resource set. The URIs must be Amazon Resource Names
	// (ARNs).
	//
	// This member is required.
	Items []string

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	ResourceSetIdentifier *string
	// contains filtered or unexported fields
}

type BatchDisassociateResourceOutput added in v1.20.0

type BatchDisassociateResourceOutput struct {

	// The resources that failed to disassociate from the resource set.
	//
	// This member is required.
	FailedItems []types.FailedItem

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	ResourceSetIdentifier *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client

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

Client provides the API client to make operations call for Firewall Management Service.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateAdminAccount

func (c *Client) AssociateAdminAccount(ctx context.Context, params *AssociateAdminAccountInput, optFns ...func(*Options)) (*AssociateAdminAccountOutput, error)

Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect. For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators (https://docs.aws.amazon.com/organizations/latest/userguide/fms-administrators.html) in the Firewall Manager Developer Guide.

func (*Client) AssociateThirdPartyFirewall added in v1.17.0

func (c *Client) AssociateThirdPartyFirewall(ctx context.Context, params *AssociateThirdPartyFirewallInput, optFns ...func(*Options)) (*AssociateThirdPartyFirewallOutput, error)

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.

func (*Client) BatchAssociateResource added in v1.20.0

func (c *Client) BatchAssociateResource(ctx context.Context, params *BatchAssociateResourceInput, optFns ...func(*Options)) (*BatchAssociateResourceOutput, error)

Associate resources to a Firewall Manager resource set.

func (*Client) BatchDisassociateResource added in v1.20.0

func (c *Client) BatchDisassociateResource(ctx context.Context, params *BatchDisassociateResourceInput, optFns ...func(*Options)) (*BatchDisassociateResourceOutput, error)

Disassociates resources from a Firewall Manager resource set.

func (*Client) DeleteAppsList

func (c *Client) DeleteAppsList(ctx context.Context, params *DeleteAppsListInput, optFns ...func(*Options)) (*DeleteAppsListOutput, error)

Permanently deletes an Firewall Manager applications list.

func (*Client) DeleteNotificationChannel

func (c *Client) DeleteNotificationChannel(ctx context.Context, params *DeleteNotificationChannelInput, optFns ...func(*Options)) (*DeleteNotificationChannelOutput, error)

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

func (*Client) DeletePolicy

func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error)

Permanently deletes an Firewall Manager policy.

func (*Client) DeleteProtocolsList

func (c *Client) DeleteProtocolsList(ctx context.Context, params *DeleteProtocolsListInput, optFns ...func(*Options)) (*DeleteProtocolsListOutput, error)

Permanently deletes an Firewall Manager protocols list.

func (*Client) DeleteResourceSet added in v1.20.0

func (c *Client) DeleteResourceSet(ctx context.Context, params *DeleteResourceSetInput, optFns ...func(*Options)) (*DeleteResourceSetOutput, error)

Deletes the specified ResourceSet .

func (*Client) DisassociateAdminAccount

func (c *Client) DisassociateAdminAccount(ctx context.Context, params *DisassociateAdminAccountInput, optFns ...func(*Options)) (*DisassociateAdminAccountOutput, error)

Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request. Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.

func (*Client) DisassociateThirdPartyFirewall added in v1.17.0

func (c *Client) DisassociateThirdPartyFirewall(ctx context.Context, params *DisassociateThirdPartyFirewallInput, optFns ...func(*Options)) (*DisassociateThirdPartyFirewallOutput, error)

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall , the third-party firewall vendor deletes all of the firewalls that are associated with the account.

func (*Client) GetAdminAccount

func (c *Client) GetAdminAccount(ctx context.Context, params *GetAdminAccountInput, optFns ...func(*Options)) (*GetAdminAccountOutput, error)

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.

func (*Client) GetAdminScope added in v1.23.0

func (c *Client) GetAdminScope(ctx context.Context, params *GetAdminScopeInput, optFns ...func(*Options)) (*GetAdminScopeOutput, error)

Returns information about the specified account's administrative scope. The admistrative scope defines the resources that an Firewall Manager administrator can manage.

func (*Client) GetAppsList

func (c *Client) GetAppsList(ctx context.Context, params *GetAppsListInput, optFns ...func(*Options)) (*GetAppsListOutput, error)

Returns information about the specified Firewall Manager applications list.

func (*Client) GetComplianceDetail

func (c *Client) GetComplianceDetail(ctx context.Context, params *GetComplianceDetailInput, optFns ...func(*Options)) (*GetComplianceDetailOutput, error)

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 noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them.
  • Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.
  • Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
  • Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.

func (*Client) GetNotificationChannel

func (c *Client) GetNotificationChannel(ctx context.Context, params *GetNotificationChannelInput, optFns ...func(*Options)) (*GetNotificationChannelOutput, error)

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

func (*Client) GetPolicy

func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error)

Returns information about the specified Firewall Manager policy.

func (*Client) GetProtectionStatus

func (c *Client) GetProtectionStatus(ctx context.Context, params *GetProtectionStatusInput, optFns ...func(*Options)) (*GetProtectionStatusOutput, error)

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

func (*Client) GetProtocolsList

func (c *Client) GetProtocolsList(ctx context.Context, params *GetProtocolsListInput, optFns ...func(*Options)) (*GetProtocolsListOutput, error)

Returns information about the specified Firewall Manager protocols list.

func (*Client) GetResourceSet added in v1.20.0

func (c *Client) GetResourceSet(ctx context.Context, params *GetResourceSetInput, optFns ...func(*Options)) (*GetResourceSetOutput, error)

Gets information about a specific resource set.

func (*Client) GetThirdPartyFirewallAssociationStatus added in v1.17.0

func (c *Client) GetThirdPartyFirewallAssociationStatus(ctx context.Context, params *GetThirdPartyFirewallAssociationStatusInput, optFns ...func(*Options)) (*GetThirdPartyFirewallAssociationStatusOutput, error)

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

func (*Client) GetViolationDetails

func (c *Client) GetViolationDetails(ctx context.Context, params *GetViolationDetailsInput, optFns ...func(*Options)) (*GetViolationDetailsOutput, error)

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

func (*Client) ListAdminAccountsForOrganization added in v1.23.0

func (c *Client) ListAdminAccountsForOrganization(ctx context.Context, params *ListAdminAccountsForOrganizationInput, optFns ...func(*Options)) (*ListAdminAccountsForOrganizationOutput, error)

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount . This operation can be called only from the organization's management account.

func (*Client) ListAdminsManagingAccount added in v1.23.0

func (c *Client) ListAdminsManagingAccount(ctx context.Context, params *ListAdminsManagingAccountInput, optFns ...func(*Options)) (*ListAdminsManagingAccountOutput, error)

Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope .

func (*Client) ListAppsLists

func (c *Client) ListAppsLists(ctx context.Context, params *ListAppsListsInput, optFns ...func(*Options)) (*ListAppsListsOutput, error)

Returns an array of AppsListDataSummary objects.

func (*Client) ListComplianceStatus

func (c *Client) ListComplianceStatus(ctx context.Context, params *ListComplianceStatusInput, optFns ...func(*Options)) (*ListComplianceStatusOutput, error)

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

func (*Client) ListDiscoveredResources added in v1.20.0

func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscoveredResourcesInput, optFns ...func(*Options)) (*ListDiscoveredResourcesOutput, error)

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.

func (*Client) ListMemberAccounts

func (c *Client) ListMemberAccounts(ctx context.Context, params *ListMemberAccountsInput, optFns ...func(*Options)) (*ListMemberAccountsOutput, error)

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. Either an Firewall Manager administrator or the organization's management account can make this request.

func (*Client) ListPolicies

func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error)

Returns an array of PolicySummary objects.

func (*Client) ListProtocolsLists

func (c *Client) ListProtocolsLists(ctx context.Context, params *ListProtocolsListsInput, optFns ...func(*Options)) (*ListProtocolsListsOutput, error)

Returns an array of ProtocolsListDataSummary objects.

func (*Client) ListResourceSetResources added in v1.20.0

func (c *Client) ListResourceSetResources(ctx context.Context, params *ListResourceSetResourcesInput, optFns ...func(*Options)) (*ListResourceSetResourcesOutput, error)

Returns an array of resources that are currently associated to a resource set.

func (*Client) ListResourceSets added in v1.20.0

func (c *Client) ListResourceSets(ctx context.Context, params *ListResourceSetsInput, optFns ...func(*Options)) (*ListResourceSetsOutput, error)

Returns an array of ResourceSetSummary objects.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Retrieves the list of tags for the specified Amazon Web Services resource.

func (*Client) ListThirdPartyFirewallFirewallPolicies added in v1.17.0

func (c *Client) ListThirdPartyFirewallFirewallPolicies(ctx context.Context, params *ListThirdPartyFirewallFirewallPoliciesInput, optFns ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error)

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.

func (*Client) PutAdminAccount added in v1.23.0

func (c *Client) PutAdminAccount(ctx context.Context, params *PutAdminAccountInput, optFns ...func(*Options)) (*PutAdminAccountOutput, error)

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount . Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html) .

func (*Client) PutAppsList

func (c *Client) PutAppsList(ctx context.Context, params *PutAppsListInput, optFns ...func(*Options)) (*PutAppsListOutput, error)

Creates an Firewall Manager applications list.

func (*Client) PutNotificationChannel

func (c *Client) PutNotificationChannel(ctx context.Context, params *PutNotificationChannelInput, optFns ...func(*Options)) (*PutNotificationChannelOutput, error)

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager (https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service) in the Firewall Manager Developer Guide.

func (*Client) PutPolicy

func (c *Client) PutPolicy(ctx context.Context, params *PutPolicyInput, optFns ...func(*Options)) (*PutPolicyOutput, error)

Creates an Firewall Manager policy. Firewall Manager provides the following types of policies:

  • An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.
  • An WAF Classic policy (type WAF), which defines a rule group.
  • A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
  • A security group policy, which manages VPC security groups across your Amazon Web Services organization.
  • An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
  • A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs.

Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription (https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html) .

func (*Client) PutProtocolsList

func (c *Client) PutProtocolsList(ctx context.Context, params *PutProtocolsListInput, optFns ...func(*Options)) (*PutProtocolsListOutput, error)

Creates an Firewall Manager protocols list.

func (*Client) PutResourceSet added in v1.20.0

func (c *Client) PutResourceSet(ctx context.Context, params *PutResourceSetInput, optFns ...func(*Options)) (*PutResourceSetOutput, error)

Creates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more tags to an Amazon Web Services resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from an Amazon Web Services resource.

type DeleteAppsListInput

type DeleteAppsListInput struct {

	// The ID of the applications list that you want to delete. You can retrieve this
	// ID from PutAppsList , ListAppsLists , and GetAppsList .
	//
	// This member is required.
	ListId *string
	// contains filtered or unexported fields
}

type DeleteAppsListOutput

type DeleteAppsListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNotificationChannelInput

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

type DeleteNotificationChannelOutput

type DeleteNotificationChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePolicyInput

type DeletePolicyInput struct {

	// The ID of the policy that you want to delete. You can retrieve this ID from
	// PutPolicy and ListPolicies .
	//
	// This member is required.
	PolicyId *string

	// If True , the request performs cleanup according to the policy type. For WAF and
	// Shield Advanced policies, the cleanup does the following:
	//   - Deletes rule groups created by Firewall Manager
	//   - Removes web ACLs from in-scope resources
	//   - Deletes web ACLs that contain no rules or rule groups
	// For security group policies, the cleanup does the following for each security
	// group in the policy:
	//   - Disassociates the security group from in-scope resources
	//   - Deletes the security group if it was created through Firewall Manager and
	//   if it's no longer associated with any resources through another policy
	// After the cleanup, in-scope resources are no longer protected by web ACLs in
	// this policy. Protection of out-of-scope resources remains unchanged. Scope is
	// determined by tags that you create and accounts that you associate with the
	// policy. When creating the policy, if you specify that only resources in specific
	// accounts or with specific tags are in scope of the policy, those accounts and
	// resources are handled by the policy. All others are out of scope. If you don't
	// specify tags or accounts, all resources are in scope.
	DeleteAllPolicyResources bool
	// contains filtered or unexported fields
}

type DeletePolicyOutput

type DeletePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProtocolsListInput

type DeleteProtocolsListInput struct {

	// The ID of the protocols list that you want to delete. You can retrieve this ID
	// from PutProtocolsList , ListProtocolsLists , and GetProtocolsLost .
	//
	// This member is required.
	ListId *string
	// contains filtered or unexported fields
}

type DeleteProtocolsListOutput

type DeleteProtocolsListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourceSetInput added in v1.20.0

type DeleteResourceSetInput struct {

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteResourceSetOutput added in v1.20.0

type DeleteResourceSetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateAdminAccountInput

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

type DisassociateAdminAccountOutput

type DisassociateAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateThirdPartyFirewallInput added in v1.17.0

type DisassociateThirdPartyFirewallInput struct {

	// The name of the third-party firewall vendor.
	//
	// This member is required.
	ThirdPartyFirewall types.ThirdPartyFirewall
	// contains filtered or unexported fields
}

type DisassociateThirdPartyFirewallOutput added in v1.17.0

type DisassociateThirdPartyFirewallOutput struct {

	// The current status for the disassociation of a Firewall Manager administrators
	// account with a third-party firewall.
	ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetAdminAccountInput

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

type GetAdminAccountOutput

type GetAdminAccountOutput struct {

	// The account that is set as the Firewall Manager default administrator.
	AdminAccount *string

	// The status of the account that you set as the Firewall Manager default
	// administrator.
	RoleStatus types.AccountRoleStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAdminScopeInput added in v1.23.0

type GetAdminScopeInput struct {

	// The administator account that you want to get the details for.
	//
	// This member is required.
	AdminAccount *string
	// contains filtered or unexported fields
}

type GetAdminScopeOutput added in v1.23.0

type GetAdminScopeOutput struct {

	// Contains details about the administrative scope of the requested account.
	AdminScope *types.AdminScope

	// The current status of the request to onboard a member account as an Firewall
	// Manager administator.
	//   - ONBOARDING - The account is onboarding to Firewall Manager as an
	//   administrator.
	//   - ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall
	//   Manager as an administrator, and can perform actions on the resources defined in
	//   their AdminScope .
	//   - OFFBOARDING - The account is being removed as an Firewall Manager
	//   administrator.
	//   - OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager
	//   administrator.
	Status types.OrganizationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppsListInput

type GetAppsListInput struct {

	// The ID of the Firewall Manager applications list that you want the details for.
	//
	// This member is required.
	ListId *string

	// Specifies whether the list to retrieve is a default list owned by Firewall
	// Manager.
	DefaultList bool
	// contains filtered or unexported fields
}

type GetAppsListOutput

type GetAppsListOutput struct {

	// Information about the specified Firewall Manager applications list.
	AppsList *types.AppsListData

	// The Amazon Resource Name (ARN) of the applications list.
	AppsListArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetComplianceDetailInput

type GetComplianceDetailInput struct {

	// The Amazon Web Services account that owns the resources that you want to get
	// the details for.
	//
	// This member is required.
	MemberAccount *string

	// The ID of the policy that you want to get the details for. PolicyId is returned
	// by PutPolicy and by ListPolicies .
	//
	// This member is required.
	PolicyId *string
	// contains filtered or unexported fields
}

type GetComplianceDetailOutput

type GetComplianceDetailOutput struct {

	// Information about the resources and the policy that you specified in the
	// GetComplianceDetail request.
	PolicyComplianceDetail *types.PolicyComplianceDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetNotificationChannelInput

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

type GetNotificationChannelOutput

type GetNotificationChannelOutput struct {

	// The IAM role that is used by Firewall Manager to record activity to SNS.
	SnsRoleName *string

	// The SNS topic that records Firewall Manager activity.
	SnsTopicArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPolicyInput

type GetPolicyInput struct {

	// The ID of the Firewall Manager policy that you want the details for.
	//
	// This member is required.
	PolicyId *string
	// contains filtered or unexported fields
}

type GetPolicyOutput

type GetPolicyOutput struct {

	// Information about the specified Firewall Manager policy.
	Policy *types.Policy

	// The Amazon Resource Name (ARN) of the specified policy.
	PolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProtectionStatusInput

type GetProtectionStatusInput struct {

	// The ID of the policy for which you want to get the attack information.
	//
	// This member is required.
	PolicyId *string

	// The end of the time period to query for the attacks. This is a timestamp type.
	// The request syntax listing indicates a number type because the default used by
	// Firewall Manager is Unix time in seconds. However, any valid timestamp format
	// is allowed.
	EndTime *time.Time

	// Specifies the number of objects that you want 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 *int32

	// The Amazon Web Services account that is in scope of the policy that you want to
	// get the details for.
	MemberAccountId *string

	// If you specify a value for MaxResults and you have more objects than the number
	// that you specify for MaxResults , Firewall Manager returns a NextToken value in
	// the response, which you can use to retrieve 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

	// The start of the time period to query for the attacks. This is a timestamp
	// type. The request syntax listing indicates a number type because the default
	// used by Firewall Manager is Unix time in seconds. However, any valid timestamp
	// format is allowed.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type GetProtectionStatusOutput

type GetProtectionStatusOutput struct {

	// The ID of the Firewall Manager administrator account for this policy.
	AdminAccountId *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.
	Data *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. Amazon Web
	// Services 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

	// The service type that is protected by the policy. Currently, this is always
	// SHIELD_ADVANCED .
	ServiceType types.SecurityServiceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProtocolsListInput

type GetProtocolsListInput struct {

	// The ID of the Firewall Manager protocols list that you want the details for.
	//
	// This member is required.
	ListId *string

	// Specifies whether the list to retrieve is a default list owned by Firewall
	// Manager.
	DefaultList bool
	// contains filtered or unexported fields
}

type GetProtocolsListOutput

type GetProtocolsListOutput struct {

	// Information about the specified Firewall Manager protocols list.
	ProtocolsList *types.ProtocolsListData

	// The Amazon Resource Name (ARN) of the specified protocols list.
	ProtocolsListArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceSetInput added in v1.20.0

type GetResourceSetInput struct {

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetResourceSetOutput added in v1.20.0

type GetResourceSetOutput struct {

	// Information about the specified resource set.
	//
	// This member is required.
	ResourceSet *types.ResourceSet

	// The Amazon Resource Name (ARN) of the resource set.
	//
	// This member is required.
	ResourceSetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetThirdPartyFirewallAssociationStatusInput added in v1.17.0

type GetThirdPartyFirewallAssociationStatusInput struct {

	// The name of the third-party firewall vendor.
	//
	// This member is required.
	ThirdPartyFirewall types.ThirdPartyFirewall
	// contains filtered or unexported fields
}

type GetThirdPartyFirewallAssociationStatusOutput added in v1.17.0

type GetThirdPartyFirewallAssociationStatusOutput struct {

	// The status for subscribing to the third-party firewall vendor in the Amazon Web
	// Services Marketplace.
	//   - NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed
	//   to the third-party firewall service in the Amazon Web Services Marketplace.
	//   - NOT_COMPLETE - The Firewall Manager policy administrator is in the process
	//   of subscribing to the third-party firewall service in the Amazon Web Services
	//   Marketplace, but doesn't yet have an active subscription.
	//   - COMPLETE - The Firewall Manager policy administrator has an active
	//   subscription to the third-party firewall service in the Amazon Web Services
	//   Marketplace.
	MarketplaceOnboardingStatus types.MarketplaceSubscriptionOnboardingStatus

	// The current status for setting a Firewall Manager policy administrators account
	// as an administrator of the third-party firewall tenant.
	//   - ONBOARDING - The Firewall Manager policy administrator is being designated
	//   as a tenant administrator.
	//   - ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated
	//   as a tenant administrator.
	//   - OFFBOARDING - The Firewall Manager policy administrator is being removed as
	//   a tenant administrator.
	//   - OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been
	//   removed as a tenant administrator.
	//   - NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a
	//   tenant administrator.
	ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetViolationDetailsInput

type GetViolationDetailsInput struct {

	// The Amazon Web Services account ID that you want the details for.
	//
	// This member is required.
	MemberAccount *string

	// The ID of the Firewall Manager policy that you want the details for. This
	// currently only supports security group content audit policies.
	//
	// This member is required.
	PolicyId *string

	// The ID of the resource that has violations.
	//
	// This member is required.
	ResourceId *string

	// The resource type. This is in the format shown in the Amazon Web Services
	// Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// . Supported resource types are: AWS::EC2::Instance , AWS::EC2::NetworkInterface
	// , AWS::EC2::SecurityGroup , AWS::NetworkFirewall::FirewallPolicy , and
	// AWS::EC2::Subnet .
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

type GetViolationDetailsOutput

type GetViolationDetailsOutput struct {

	// Violation detail for a resource.
	ViolationDetail *types.ViolationDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAdminAccountsForOrganizationAPIClient added in v1.23.0

type ListAdminAccountsForOrganizationAPIClient interface {
	ListAdminAccountsForOrganization(context.Context, *ListAdminAccountsForOrganizationInput, ...func(*Options)) (*ListAdminAccountsForOrganizationOutput, error)
}

ListAdminAccountsForOrganizationAPIClient is a client that implements the ListAdminAccountsForOrganization operation.

type ListAdminAccountsForOrganizationInput added in v1.23.0

type ListAdminAccountsForOrganizationInput struct {

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	MaxResults *int32

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAdminAccountsForOrganizationOutput added in v1.23.0

type ListAdminAccountsForOrganizationOutput struct {

	// A list of Firewall Manager administrator accounts within the organization that
	// were onboarded as administrators by AssociateAdminAccount or PutAdminAccount .
	AdminAccounts []types.AdminAccountSummary

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAdminAccountsForOrganizationPaginator added in v1.23.0

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

ListAdminAccountsForOrganizationPaginator is a paginator for ListAdminAccountsForOrganization

func NewListAdminAccountsForOrganizationPaginator added in v1.23.0

NewListAdminAccountsForOrganizationPaginator returns a new ListAdminAccountsForOrganizationPaginator

func (*ListAdminAccountsForOrganizationPaginator) HasMorePages added in v1.23.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAdminAccountsForOrganizationPaginator) NextPage added in v1.23.0

NextPage retrieves the next ListAdminAccountsForOrganization page.

type ListAdminAccountsForOrganizationPaginatorOptions added in v1.23.0

type ListAdminAccountsForOrganizationPaginatorOptions struct {
	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAdminAccountsForOrganizationPaginatorOptions is the paginator options for ListAdminAccountsForOrganization

type ListAdminsManagingAccountAPIClient added in v1.23.0

type ListAdminsManagingAccountAPIClient interface {
	ListAdminsManagingAccount(context.Context, *ListAdminsManagingAccountInput, ...func(*Options)) (*ListAdminsManagingAccountOutput, error)
}

ListAdminsManagingAccountAPIClient is a client that implements the ListAdminsManagingAccount operation.

type ListAdminsManagingAccountInput added in v1.23.0

type ListAdminsManagingAccountInput struct {

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	MaxResults *int32

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAdminsManagingAccountOutput added in v1.23.0

type ListAdminsManagingAccountOutput struct {

	// The list of accounts who manage member accounts within their AdminScope .
	AdminAccounts []string

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAdminsManagingAccountPaginator added in v1.23.0

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

ListAdminsManagingAccountPaginator is a paginator for ListAdminsManagingAccount

func NewListAdminsManagingAccountPaginator added in v1.23.0

NewListAdminsManagingAccountPaginator returns a new ListAdminsManagingAccountPaginator

func (*ListAdminsManagingAccountPaginator) HasMorePages added in v1.23.0

func (p *ListAdminsManagingAccountPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAdminsManagingAccountPaginator) NextPage added in v1.23.0

NextPage retrieves the next ListAdminsManagingAccount page.

type ListAdminsManagingAccountPaginatorOptions added in v1.23.0

type ListAdminsManagingAccountPaginatorOptions struct {
	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAdminsManagingAccountPaginatorOptions is the paginator options for ListAdminsManagingAccount

type ListAppsListsAPIClient added in v1.6.0

type ListAppsListsAPIClient interface {
	ListAppsLists(context.Context, *ListAppsListsInput, ...func(*Options)) (*ListAppsListsOutput, error)
}

ListAppsListsAPIClient is a client that implements the ListAppsLists operation.

type ListAppsListsInput

type ListAppsListsInput struct {

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects. If you don't specify this, Firewall Manager returns all
	// available objects.
	//
	// This member is required.
	MaxResults *int32

	// Specifies whether the lists to retrieve are default lists owned by Firewall
	// Manager.
	DefaultLists bool

	// If you specify a value for MaxResults in your list request, and you have more
	// objects than the maximum, Firewall Manager returns this token in the response.
	// For all but the first request, you provide the token returned by the prior
	// request in the request parameters, to retrieve the next batch of objects.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppsListsOutput

type ListAppsListsOutput struct {

	// An array of AppsListDataSummary objects.
	AppsLists []types.AppsListDataSummary

	// If you specify a value for MaxResults in your list request, and you have more
	// objects than the maximum, Firewall Manager returns this token in the response.
	// You can use this token in subsequent requests to retrieve the next batch of
	// objects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppsListsPaginator added in v1.6.0

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

ListAppsListsPaginator is a paginator for ListAppsLists

func NewListAppsListsPaginator added in v1.6.0

func NewListAppsListsPaginator(client ListAppsListsAPIClient, params *ListAppsListsInput, optFns ...func(*ListAppsListsPaginatorOptions)) *ListAppsListsPaginator

NewListAppsListsPaginator returns a new ListAppsListsPaginator

func (*ListAppsListsPaginator) HasMorePages added in v1.6.0

func (p *ListAppsListsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppsListsPaginator) NextPage added in v1.6.0

func (p *ListAppsListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppsListsOutput, error)

NextPage retrieves the next ListAppsLists page.

type ListAppsListsPaginatorOptions added in v1.6.0

type ListAppsListsPaginatorOptions struct {
	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects. If you don't specify this, Firewall Manager returns all
	// available objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppsListsPaginatorOptions is the paginator options for ListAppsLists

type ListComplianceStatusAPIClient added in v0.30.0

type ListComplianceStatusAPIClient interface {
	ListComplianceStatus(context.Context, *ListComplianceStatusInput, ...func(*Options)) (*ListComplianceStatusOutput, error)
}

ListComplianceStatusAPIClient is a client that implements the ListComplianceStatus operation.

type ListComplianceStatusInput

type ListComplianceStatusInput struct {

	// The ID of the Firewall Manager policy that you want the details for.
	//
	// This member is required.
	PolicyId *string

	// Specifies the number of PolicyComplianceStatus objects that you want 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 *int32

	// If you specify a value for MaxResults and you have more PolicyComplianceStatus
	// objects than the number that you specify for MaxResults , 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
	// contains filtered or unexported fields
}

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

	// An array of PolicyComplianceStatus objects.
	PolicyComplianceStatusList []types.PolicyComplianceStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListComplianceStatusPaginator added in v0.30.0

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

ListComplianceStatusPaginator is a paginator for ListComplianceStatus

func NewListComplianceStatusPaginator added in v0.30.0

NewListComplianceStatusPaginator returns a new ListComplianceStatusPaginator

func (*ListComplianceStatusPaginator) HasMorePages added in v0.30.0

func (p *ListComplianceStatusPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListComplianceStatusPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListComplianceStatus page.

type ListComplianceStatusPaginatorOptions added in v0.30.0

type ListComplianceStatusPaginatorOptions struct {
	// Specifies the number of PolicyComplianceStatus objects that you want 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListComplianceStatusPaginatorOptions is the paginator options for ListComplianceStatus

type ListDiscoveredResourcesInput added in v1.20.0

type ListDiscoveredResourcesInput struct {

	// The Amazon Web Services account IDs to discover resources in. Only one account
	// is supported per request. The account must be a member of your organization.
	//
	// This member is required.
	MemberAccountIds []string

	// The type of resources to discover.
	//
	// This member is required.
	ResourceType *string

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	MaxResults *int32

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDiscoveredResourcesOutput added in v1.20.0

type ListDiscoveredResourcesOutput struct {

	// Details of the resources that were discovered.
	Items []types.DiscoveredResource

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMemberAccountsAPIClient added in v0.30.0

type ListMemberAccountsAPIClient interface {
	ListMemberAccounts(context.Context, *ListMemberAccountsInput, ...func(*Options)) (*ListMemberAccountsOutput, error)
}

ListMemberAccountsAPIClient is a client that implements the ListMemberAccounts operation.

type ListMemberAccountsInput

type ListMemberAccountsInput struct {

	// Specifies the number of member account IDs that you want 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 *int32

	// If you specify a value for MaxResults and you have more account IDs than the
	// number that you specify for MaxResults , 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
	// contains filtered or unexported fields
}

type ListMemberAccountsOutput

type ListMemberAccountsOutput struct {

	// An array of account IDs.
	MemberAccounts []string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMemberAccountsPaginator added in v0.30.0

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

ListMemberAccountsPaginator is a paginator for ListMemberAccounts

func NewListMemberAccountsPaginator added in v0.30.0

func NewListMemberAccountsPaginator(client ListMemberAccountsAPIClient, params *ListMemberAccountsInput, optFns ...func(*ListMemberAccountsPaginatorOptions)) *ListMemberAccountsPaginator

NewListMemberAccountsPaginator returns a new ListMemberAccountsPaginator

func (*ListMemberAccountsPaginator) HasMorePages added in v0.30.0

func (p *ListMemberAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMemberAccountsPaginator) NextPage added in v0.30.0

func (p *ListMemberAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMemberAccountsOutput, error)

NextPage retrieves the next ListMemberAccounts page.

type ListMemberAccountsPaginatorOptions added in v0.30.0

type ListMemberAccountsPaginatorOptions struct {
	// Specifies the number of member account IDs that you want 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMemberAccountsPaginatorOptions is the paginator options for ListMemberAccounts

type ListPoliciesAPIClient added in v0.30.0

type ListPoliciesAPIClient interface {
	ListPolicies(context.Context, *ListPoliciesInput, ...func(*Options)) (*ListPoliciesOutput, error)
}

ListPoliciesAPIClient is a client that implements the ListPolicies operation.

type ListPoliciesInput

type ListPoliciesInput struct {

	// Specifies the number of PolicySummary objects that you want 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 *int32

	// If you specify a value for MaxResults and you have more PolicySummary objects
	// than the number that you specify for MaxResults , 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
	// contains filtered or unexported fields
}

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

	// An array of PolicySummary objects.
	PolicyList []types.PolicySummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPoliciesPaginator added in v0.30.0

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

ListPoliciesPaginator is a paginator for ListPolicies

func NewListPoliciesPaginator added in v0.30.0

func NewListPoliciesPaginator(client ListPoliciesAPIClient, params *ListPoliciesInput, optFns ...func(*ListPoliciesPaginatorOptions)) *ListPoliciesPaginator

NewListPoliciesPaginator returns a new ListPoliciesPaginator

func (*ListPoliciesPaginator) HasMorePages added in v0.30.0

func (p *ListPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPoliciesPaginator) NextPage added in v0.30.0

func (p *ListPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPoliciesOutput, error)

NextPage retrieves the next ListPolicies page.

type ListPoliciesPaginatorOptions added in v0.30.0

type ListPoliciesPaginatorOptions struct {
	// Specifies the number of PolicySummary objects that you want 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPoliciesPaginatorOptions is the paginator options for ListPolicies

type ListProtocolsListsAPIClient added in v1.6.0

type ListProtocolsListsAPIClient interface {
	ListProtocolsLists(context.Context, *ListProtocolsListsInput, ...func(*Options)) (*ListProtocolsListsOutput, error)
}

ListProtocolsListsAPIClient is a client that implements the ListProtocolsLists operation.

type ListProtocolsListsInput

type ListProtocolsListsInput struct {

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects. If you don't specify this, Firewall Manager returns all
	// available objects.
	//
	// This member is required.
	MaxResults *int32

	// Specifies whether the lists to retrieve are default lists owned by Firewall
	// Manager.
	DefaultLists bool

	// If you specify a value for MaxResults in your list request, and you have more
	// objects than the maximum, Firewall Manager returns this token in the response.
	// For all but the first request, you provide the token returned by the prior
	// request in the request parameters, to retrieve the next batch of objects.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProtocolsListsOutput

type ListProtocolsListsOutput struct {

	// If you specify a value for MaxResults in your list request, and you have more
	// objects than the maximum, Firewall Manager returns this token in the response.
	// You can use this token in subsequent requests to retrieve the next batch of
	// objects.
	NextToken *string

	// An array of ProtocolsListDataSummary objects.
	ProtocolsLists []types.ProtocolsListDataSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProtocolsListsPaginator added in v1.6.0

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

ListProtocolsListsPaginator is a paginator for ListProtocolsLists

func NewListProtocolsListsPaginator added in v1.6.0

func NewListProtocolsListsPaginator(client ListProtocolsListsAPIClient, params *ListProtocolsListsInput, optFns ...func(*ListProtocolsListsPaginatorOptions)) *ListProtocolsListsPaginator

NewListProtocolsListsPaginator returns a new ListProtocolsListsPaginator

func (*ListProtocolsListsPaginator) HasMorePages added in v1.6.0

func (p *ListProtocolsListsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProtocolsListsPaginator) NextPage added in v1.6.0

func (p *ListProtocolsListsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProtocolsListsOutput, error)

NextPage retrieves the next ListProtocolsLists page.

type ListProtocolsListsPaginatorOptions added in v1.6.0

type ListProtocolsListsPaginatorOptions struct {
	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects. If you don't specify this, Firewall Manager returns all
	// available objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProtocolsListsPaginatorOptions is the paginator options for ListProtocolsLists

type ListResourceSetResourcesInput added in v1.20.0

type ListResourceSetResourcesInput struct {

	// A unique identifier for the resource set, used in a request to refer to the
	// resource set.
	//
	// This member is required.
	Identifier *string

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	MaxResults *int32

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceSetResourcesOutput added in v1.20.0

type ListResourceSetResourcesOutput struct {

	// An array of the associated resources' uniform resource identifiers (URI).
	//
	// This member is required.
	Items []types.Resource

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceSetsInput added in v1.20.0

type ListResourceSetsInput struct {

	// The maximum number of objects that you want Firewall Manager to return for this
	// request. If more objects are available, in the response, Firewall Manager
	// provides a NextToken value that you can use in a subsequent call to get the
	// next batch of objects.
	MaxResults *int32

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceSetsOutput added in v1.20.0

type ListResourceSetsOutput struct {

	// When you request a list of objects with a MaxResults setting, if the number of
	// objects that are still available for retrieval exceeds the maximum you
	// requested, Firewall Manager returns a NextToken value in the response. To
	// retrieve the next batch of objects, use the token returned from the prior
	// request in your next request.
	NextToken *string

	// An array of ResourceSetSummary objects.
	ResourceSets []types.ResourceSetSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall
	// Manager resources that support tagging are policies, applications lists, and
	// protocols lists.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	TagList []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThirdPartyFirewallFirewallPoliciesAPIClient added in v1.17.0

type ListThirdPartyFirewallFirewallPoliciesAPIClient interface {
	ListThirdPartyFirewallFirewallPolicies(context.Context, *ListThirdPartyFirewallFirewallPoliciesInput, ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error)
}

ListThirdPartyFirewallFirewallPoliciesAPIClient is a client that implements the ListThirdPartyFirewallFirewallPolicies operation.

type ListThirdPartyFirewallFirewallPoliciesInput added in v1.17.0

type ListThirdPartyFirewallFirewallPoliciesInput struct {

	// The maximum number of third-party firewall policies that you want Firewall
	// Manager to return. If the specified third-party firewall vendor is associated
	// with more than MaxResults firewall policies, the response includes a NextToken
	// element. NextToken contains an encrypted token that identifies the first
	// third-party firewall policies that Firewall Manager will return if you submit
	// another request.
	//
	// This member is required.
	MaxResults *int32

	// The name of the third-party firewall vendor.
	//
	// This member is required.
	ThirdPartyFirewall types.ThirdPartyFirewall

	// If the previous response included a NextToken element, the specified
	// third-party firewall vendor is associated with more third-party firewall
	// policies. To get more third-party firewall policies, submit another
	// ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of
	// NextToken , specify the value of NextToken from the previous response. If the
	// previous response didn't include a NextToken element, there are no more
	// third-party firewall policies to get.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThirdPartyFirewallFirewallPoliciesOutput added in v1.17.0

type ListThirdPartyFirewallFirewallPoliciesOutput struct {

	// The value that you will use for NextToken in the next
	// ListThirdPartyFirewallFirewallPolicies request.
	NextToken *string

	// A list that contains one ThirdPartyFirewallFirewallPolicies element for each
	// third-party firewall policies that the specified third-party firewall vendor is
	// associated with. Each ThirdPartyFirewallFirewallPolicies element contains the
	// firewall policy name and ID.
	ThirdPartyFirewallFirewallPolicies []types.ThirdPartyFirewallFirewallPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThirdPartyFirewallFirewallPoliciesPaginator added in v1.17.0

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

ListThirdPartyFirewallFirewallPoliciesPaginator is a paginator for ListThirdPartyFirewallFirewallPolicies

func NewListThirdPartyFirewallFirewallPoliciesPaginator added in v1.17.0

NewListThirdPartyFirewallFirewallPoliciesPaginator returns a new ListThirdPartyFirewallFirewallPoliciesPaginator

func (*ListThirdPartyFirewallFirewallPoliciesPaginator) HasMorePages added in v1.17.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThirdPartyFirewallFirewallPoliciesPaginator) NextPage added in v1.17.0

NextPage retrieves the next ListThirdPartyFirewallFirewallPolicies page.

type ListThirdPartyFirewallFirewallPoliciesPaginatorOptions added in v1.17.0

type ListThirdPartyFirewallFirewallPoliciesPaginatorOptions struct {
	// The maximum number of third-party firewall policies that you want Firewall
	// Manager to return. If the specified third-party firewall vendor is associated
	// with more than MaxResults firewall policies, the response includes a NextToken
	// element. NextToken contains an encrypted token that identifies the first
	// third-party firewall policies that Firewall Manager will return if you submit
	// another request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThirdPartyFirewallFirewallPoliciesPaginatorOptions is the paginator options for ListThirdPartyFirewallFirewallPolicies

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutAdminAccountInput added in v1.23.0

type PutAdminAccountInput struct {

	// The Amazon Web Services account ID to add as an Firewall Manager administrator
	// account. The account must be a member of the organization that was onboarded to
	// Firewall Manager by AssociateAdminAccount . For more information about
	// Organizations, see Managing the Amazon Web Services Accounts in Your
	// Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html)
	// .
	//
	// This member is required.
	AdminAccount *string

	// Configures the resources that the specified Firewall Manager administrator can
	// manage. As a best practice, set the administrative scope according to the
	// principles of least privilege. Only grant the administrator the specific
	// resources or permissions that they need to perform the duties of their role.
	AdminScope *types.AdminScope
	// contains filtered or unexported fields
}

type PutAdminAccountOutput added in v1.23.0

type PutAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutAppsListInput

type PutAppsListInput struct {

	// The details of the Firewall Manager applications list to be created.
	//
	// This member is required.
	AppsList *types.AppsListData

	// The tags associated with the resource.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type PutAppsListOutput

type PutAppsListOutput struct {

	// The details of the Firewall Manager applications list.
	AppsList *types.AppsListData

	// The Amazon Resource Name (ARN) of the applications list.
	AppsListArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutNotificationChannelInput

type PutNotificationChannelInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record
	// Firewall Manager activity.
	//
	// This member is required.
	SnsRoleName *string

	// The Amazon Resource Name (ARN) of the SNS topic that collects notifications
	// from Firewall Manager.
	//
	// This member is required.
	SnsTopicArn *string
	// contains filtered or unexported fields
}

type PutNotificationChannelOutput

type PutNotificationChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutPolicyInput

type PutPolicyInput struct {

	// The details of the Firewall Manager policy to be created.
	//
	// This member is required.
	Policy *types.Policy

	// The tags to add to the Amazon Web Services resource.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type PutPolicyOutput

type PutPolicyOutput struct {

	// The details of the Firewall Manager policy.
	Policy *types.Policy

	// The Amazon Resource Name (ARN) of the policy.
	PolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutProtocolsListInput

type PutProtocolsListInput struct {

	// The details of the Firewall Manager protocols list to be created.
	//
	// This member is required.
	ProtocolsList *types.ProtocolsListData

	// The tags associated with the resource.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type PutProtocolsListOutput

type PutProtocolsListOutput struct {

	// The details of the Firewall Manager protocols list.
	ProtocolsList *types.ProtocolsListData

	// The Amazon Resource Name (ARN) of the protocols list.
	ProtocolsListArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutResourceSetInput added in v1.20.0

type PutResourceSetInput struct {

	// Details about the resource set to be created or updated.>
	//
	// This member is required.
	ResourceSet *types.ResourceSet

	// Retrieves the tags associated with the specified resource set. Tags are
	// key:value pairs that you can use to categorize and manage your resources, for
	// purposes like billing. For example, you might set the tag key to "customer" and
	// the value to the customer name or ID. You can specify one or more tags to add to
	// each Amazon Web Services resource, up to 50 tags for a resource.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type PutResourceSetOutput added in v1.20.0

type PutResourceSetOutput struct {

	// Details about the resource set.
	//
	// This member is required.
	ResourceSet *types.ResourceSet

	// The Amazon Resource Name (ARN) of the resource set.
	//
	// This member is required.
	ResourceSetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall
	// Manager resources that support tagging are policies, applications lists, and
	// protocols lists.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource.
	//
	// This member is required.
	TagList []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall
	// Manager resources that support tagging are policies, applications lists, and
	// protocols lists.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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