package networkmanager
import "github.com/aws/aws-sdk-go-v2/service/networkmanager"
Package networkmanager provides the API client, operations, and parameter types for AWS Network Manager.
Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type AssociateCustomerGatewayInput
- type AssociateCustomerGatewayOutput
- type AssociateLinkInput
- type AssociateLinkOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AssociateCustomerGateway(ctx context.Context, params *AssociateCustomerGatewayInput, optFns ...func(*Options)) (*AssociateCustomerGatewayOutput, error)
- func (c *Client) AssociateLink(ctx context.Context, params *AssociateLinkInput, optFns ...func(*Options)) (*AssociateLinkOutput, error)
- func (c *Client) CreateDevice(ctx context.Context, params *CreateDeviceInput, optFns ...func(*Options)) (*CreateDeviceOutput, error)
- func (c *Client) CreateGlobalNetwork(ctx context.Context, params *CreateGlobalNetworkInput, optFns ...func(*Options)) (*CreateGlobalNetworkOutput, error)
- func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns ...func(*Options)) (*CreateLinkOutput, error)
- func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns ...func(*Options)) (*CreateSiteOutput, error)
- func (c *Client) DeleteDevice(ctx context.Context, params *DeleteDeviceInput, optFns ...func(*Options)) (*DeleteDeviceOutput, error)
- func (c *Client) DeleteGlobalNetwork(ctx context.Context, params *DeleteGlobalNetworkInput, optFns ...func(*Options)) (*DeleteGlobalNetworkOutput, error)
- func (c *Client) DeleteLink(ctx context.Context, params *DeleteLinkInput, optFns ...func(*Options)) (*DeleteLinkOutput, error)
- func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns ...func(*Options)) (*DeleteSiteOutput, error)
- func (c *Client) DeregisterTransitGateway(ctx context.Context, params *DeregisterTransitGatewayInput, optFns ...func(*Options)) (*DeregisterTransitGatewayOutput, error)
- func (c *Client) DescribeGlobalNetworks(ctx context.Context, params *DescribeGlobalNetworksInput, optFns ...func(*Options)) (*DescribeGlobalNetworksOutput, error)
- func (c *Client) DisassociateCustomerGateway(ctx context.Context, params *DisassociateCustomerGatewayInput, optFns ...func(*Options)) (*DisassociateCustomerGatewayOutput, error)
- func (c *Client) DisassociateLink(ctx context.Context, params *DisassociateLinkInput, optFns ...func(*Options)) (*DisassociateLinkOutput, error)
- func (c *Client) GetCustomerGatewayAssociations(ctx context.Context, params *GetCustomerGatewayAssociationsInput, optFns ...func(*Options)) (*GetCustomerGatewayAssociationsOutput, error)
- func (c *Client) GetDevices(ctx context.Context, params *GetDevicesInput, optFns ...func(*Options)) (*GetDevicesOutput, error)
- func (c *Client) GetLinkAssociations(ctx context.Context, params *GetLinkAssociationsInput, optFns ...func(*Options)) (*GetLinkAssociationsOutput, error)
- func (c *Client) GetLinks(ctx context.Context, params *GetLinksInput, optFns ...func(*Options)) (*GetLinksOutput, error)
- func (c *Client) GetSites(ctx context.Context, params *GetSitesInput, optFns ...func(*Options)) (*GetSitesOutput, error)
- func (c *Client) GetTransitGatewayRegistrations(ctx context.Context, params *GetTransitGatewayRegistrationsInput, optFns ...func(*Options)) (*GetTransitGatewayRegistrationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) RegisterTransitGateway(ctx context.Context, params *RegisterTransitGatewayInput, optFns ...func(*Options)) (*RegisterTransitGatewayOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateDevice(ctx context.Context, params *UpdateDeviceInput, optFns ...func(*Options)) (*UpdateDeviceOutput, error)
- func (c *Client) UpdateGlobalNetwork(ctx context.Context, params *UpdateGlobalNetworkInput, optFns ...func(*Options)) (*UpdateGlobalNetworkOutput, error)
- func (c *Client) UpdateLink(ctx context.Context, params *UpdateLinkInput, optFns ...func(*Options)) (*UpdateLinkOutput, error)
- func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns ...func(*Options)) (*UpdateSiteOutput, error)
- type CreateDeviceInput
- type CreateDeviceOutput
- type CreateGlobalNetworkInput
- type CreateGlobalNetworkOutput
- type CreateLinkInput
- type CreateLinkOutput
- type CreateSiteInput
- type CreateSiteOutput
- type DeleteDeviceInput
- type DeleteDeviceOutput
- type DeleteGlobalNetworkInput
- type DeleteGlobalNetworkOutput
- type DeleteLinkInput
- type DeleteLinkOutput
- type DeleteSiteInput
- type DeleteSiteOutput
- type DeregisterTransitGatewayInput
- type DeregisterTransitGatewayOutput
- type DescribeGlobalNetworksInput
- type DescribeGlobalNetworksOutput
- type DisassociateCustomerGatewayInput
- type DisassociateCustomerGatewayOutput
- type DisassociateLinkInput
- type DisassociateLinkOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetCustomerGatewayAssociationsInput
- type GetCustomerGatewayAssociationsOutput
- type GetDevicesInput
- type GetDevicesOutput
- type GetLinkAssociationsInput
- type GetLinkAssociationsOutput
- type GetLinksInput
- type GetLinksOutput
- type GetSitesInput
- type GetSitesOutput
- type GetTransitGatewayRegistrationsInput
- type GetTransitGatewayRegistrationsOutput
- type HTTPClient
- type HTTPSignerV4
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type RegisterTransitGatewayInput
- type RegisterTransitGatewayOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateDeviceInput
- type UpdateDeviceOutput
- type UpdateGlobalNetworkInput
- type UpdateGlobalNetworkOutput
- type UpdateLinkInput
- type UpdateLinkOutput
- type UpdateSiteInput
- type UpdateSiteOutput
Constants ¶
const ServiceAPIVersion = "2019-07-05"
const ServiceID = "NetworkManager"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type AssociateCustomerGatewayInput ¶
type AssociateCustomerGatewayInput struct { // The Amazon Resource Name (ARN) of the customer gateway. For more information, // see Resources Defined by Amazon EC2 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies). // // This member is required. CustomerGatewayArn *string // The ID of the device. // // This member is required. DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the link. LinkId *string }
type AssociateCustomerGatewayOutput ¶
type AssociateCustomerGatewayOutput struct { // The customer gateway association. CustomerGatewayAssociation *types.CustomerGatewayAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AssociateLinkInput ¶
type AssociateLinkInput struct { // The ID of the device. // // This member is required. DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the link. // // This member is required. LinkId *string }
type AssociateLinkOutput ¶
type AssociateLinkOutput struct { // The link association. LinkAssociation *types.LinkAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Network Manager.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateCustomerGateway ¶
func (c *Client) AssociateCustomerGateway(ctx context.Context, params *AssociateCustomerGatewayInput, optFns ...func(*Options)) (*AssociateCustomerGatewayOutput, error)
Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) EC2 API and filter by transit-gateway-id. You cannot associate a customer gateway with more than one device and link.
func (*Client) AssociateLink ¶
func (c *Client) AssociateLink(ctx context.Context, params *AssociateLinkInput, optFns ...func(*Options)) (*AssociateLinkOutput, error)
Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
func (*Client) CreateDevice ¶
func (c *Client) CreateDevice(ctx context.Context, params *CreateDeviceInput, optFns ...func(*Options)) (*CreateDeviceOutput, error)
Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.
func (*Client) CreateGlobalNetwork ¶
func (c *Client) CreateGlobalNetwork(ctx context.Context, params *CreateGlobalNetworkInput, optFns ...func(*Options)) (*CreateGlobalNetworkOutput, error)
Creates a new, empty global network.
func (*Client) CreateLink ¶
func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns ...func(*Options)) (*CreateLinkOutput, error)
Creates a new link for a specified site.
func (*Client) CreateSite ¶
func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns ...func(*Options)) (*CreateSiteOutput, error)
Creates a new site in a global network.
func (*Client) DeleteDevice ¶
func (c *Client) DeleteDevice(ctx context.Context, params *DeleteDeviceInput, optFns ...func(*Options)) (*DeleteDeviceOutput, error)
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
func (*Client) DeleteGlobalNetwork ¶
func (c *Client) DeleteGlobalNetwork(ctx context.Context, params *DeleteGlobalNetworkInput, optFns ...func(*Options)) (*DeleteGlobalNetworkOutput, error)
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
func (*Client) DeleteLink ¶
func (c *Client) DeleteLink(ctx context.Context, params *DeleteLinkInput, optFns ...func(*Options)) (*DeleteLinkOutput, error)
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
func (*Client) DeleteSite ¶
func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns ...func(*Options)) (*DeleteSiteOutput, error)
Deletes an existing site. The site cannot be associated with any device or link.
func (*Client) DeregisterTransitGateway ¶
func (c *Client) DeregisterTransitGateway(ctx context.Context, params *DeregisterTransitGatewayInput, optFns ...func(*Options)) (*DeregisterTransitGatewayOutput, error)
Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
func (*Client) DescribeGlobalNetworks ¶
func (c *Client) DescribeGlobalNetworks(ctx context.Context, params *DescribeGlobalNetworksInput, optFns ...func(*Options)) (*DescribeGlobalNetworksOutput, error)
Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.
func (*Client) DisassociateCustomerGateway ¶
func (c *Client) DisassociateCustomerGateway(ctx context.Context, params *DisassociateCustomerGatewayInput, optFns ...func(*Options)) (*DisassociateCustomerGatewayOutput, error)
Disassociates a customer gateway from a device and a link.
func (*Client) DisassociateLink ¶
func (c *Client) DisassociateLink(ctx context.Context, params *DisassociateLinkInput, optFns ...func(*Options)) (*DisassociateLinkOutput, error)
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
func (*Client) GetCustomerGatewayAssociations ¶
func (c *Client) GetCustomerGatewayAssociations(ctx context.Context, params *GetCustomerGatewayAssociationsInput, optFns ...func(*Options)) (*GetCustomerGatewayAssociationsOutput, error)
Gets the association information for customer gateways that are associated with devices and links in your global network.
func (*Client) GetDevices ¶
func (c *Client) GetDevices(ctx context.Context, params *GetDevicesInput, optFns ...func(*Options)) (*GetDevicesOutput, error)
Gets information about one or more of your devices in a global network.
func (*Client) GetLinkAssociations ¶
func (c *Client) GetLinkAssociations(ctx context.Context, params *GetLinkAssociationsInput, optFns ...func(*Options)) (*GetLinkAssociationsOutput, error)
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
func (*Client) GetLinks ¶
func (c *Client) GetLinks(ctx context.Context, params *GetLinksInput, optFns ...func(*Options)) (*GetLinksOutput, error)
Gets information about one or more links in a specified global network. If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.
func (*Client) GetSites ¶
func (c *Client) GetSites(ctx context.Context, params *GetSitesInput, optFns ...func(*Options)) (*GetSitesOutput, error)
Gets information about one or more of your sites in a global network.
func (*Client) GetTransitGatewayRegistrations ¶
func (c *Client) GetTransitGatewayRegistrations(ctx context.Context, params *GetTransitGatewayRegistrationsInput, optFns ...func(*Options)) (*GetTransitGatewayRegistrationsOutput, error)
Gets information about the transit gateway registrations in a specified global network.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for a specified resource.
func (*Client) RegisterTransitGateway ¶
func (c *Client) RegisterTransitGateway(ctx context.Context, params *RegisterTransitGatewayInput, optFns ...func(*Options)) (*RegisterTransitGatewayOutput, error)
Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Tags a specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes tags from a specified resource.
func (*Client) UpdateDevice ¶
func (c *Client) UpdateDevice(ctx context.Context, params *UpdateDeviceInput, optFns ...func(*Options)) (*UpdateDeviceOutput, error)
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
func (*Client) UpdateGlobalNetwork ¶
func (c *Client) UpdateGlobalNetwork(ctx context.Context, params *UpdateGlobalNetworkInput, optFns ...func(*Options)) (*UpdateGlobalNetworkOutput, error)
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
func (*Client) UpdateLink ¶
func (c *Client) UpdateLink(ctx context.Context, params *UpdateLinkInput, optFns ...func(*Options)) (*UpdateLinkOutput, error)
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
func (*Client) UpdateSite ¶
func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns ...func(*Options)) (*UpdateSiteOutput, error)
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
type CreateDeviceInput ¶
type CreateDeviceInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // A description of the device. Length Constraints: Maximum length of 256 // characters. Description *string // The location of the device. Location *types.Location // The model of the device. Length Constraints: Maximum length of 128 characters. Model *string // The serial number of the device. Length Constraints: Maximum length of 128 // characters. SerialNumber *string // The ID of the site. SiteId *string // The tags to apply to the resource during creation. Tags []*types.Tag // The type of the device. Type *string // The vendor of the device. Length Constraints: Maximum length of 128 characters. Vendor *string }
type CreateDeviceOutput ¶
type CreateDeviceOutput struct { // Information about the device. Device *types.Device // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateGlobalNetworkInput ¶
type CreateGlobalNetworkInput struct { // A description of the global network. Length Constraints: Maximum length of 256 // characters. Description *string // The tags to apply to the resource during creation. Tags []*types.Tag }
type CreateGlobalNetworkOutput ¶
type CreateGlobalNetworkOutput struct { // Information about the global network object. GlobalNetwork *types.GlobalNetwork // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateLinkInput ¶
type CreateLinkInput struct { // The upload speed and download speed in Mbps. // // This member is required. Bandwidth *types.Bandwidth // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the site. // // This member is required. SiteId *string // A description of the link. Length Constraints: Maximum length of 256 characters. Description *string // The provider of the link. Constraints: Cannot include the following characters: // | \ ^ Length Constraints: Maximum length of 128 characters. Provider *string // The tags to apply to the resource during creation. Tags []*types.Tag // The type of the link. Constraints: Cannot include the following characters: | \ // ^ Length Constraints: Maximum length of 128 characters. Type *string }
type CreateLinkOutput ¶
type CreateLinkOutput struct { // Information about the link. Link *types.Link // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateSiteInput ¶
type CreateSiteInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // A description of your site. Length Constraints: Maximum length of 256 // characters. Description *string // The site location. This information is used for visualization in the Network // Manager console. If you specify the address, the latitude and longitude are // automatically calculated. // // * Address: The physical address of the site. // // * // Latitude: The latitude of the site. // // * Longitude: The longitude of the site. Location *types.Location // The tags to apply to the resource during creation. Tags []*types.Tag }
type CreateSiteOutput ¶
type CreateSiteOutput struct { // Information about the site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDeviceInput ¶
type DeleteDeviceInput struct { // The ID of the device. // // This member is required. DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string }
type DeleteDeviceOutput ¶
type DeleteDeviceOutput struct { // Information about the device. Device *types.Device // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteGlobalNetworkInput ¶
type DeleteGlobalNetworkInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string }
type DeleteGlobalNetworkOutput ¶
type DeleteGlobalNetworkOutput struct { // Information about the global network. GlobalNetwork *types.GlobalNetwork // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteLinkInput ¶
type DeleteLinkInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the link. // // This member is required. LinkId *string }
type DeleteLinkOutput ¶
type DeleteLinkOutput struct { // Information about the link. Link *types.Link // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteSiteInput ¶
type DeleteSiteInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the site. // // This member is required. SiteId *string }
type DeleteSiteOutput ¶
type DeleteSiteOutput struct { // Information about the site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeregisterTransitGatewayInput ¶
type DeregisterTransitGatewayInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The Amazon Resource Name (ARN) of the transit gateway. // // This member is required. TransitGatewayArn *string }
type DeregisterTransitGatewayOutput ¶
type DeregisterTransitGatewayOutput struct { // The transit gateway registration information. TransitGatewayRegistration *types.TransitGatewayRegistration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeGlobalNetworksInput ¶
type DescribeGlobalNetworksInput struct { // The IDs of one or more global networks. The maximum is 10. GlobalNetworkIds []*string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string }
type DescribeGlobalNetworksOutput ¶
type DescribeGlobalNetworksOutput struct { // Information about the global networks. GlobalNetworks []*types.GlobalNetwork // The token for the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateCustomerGatewayInput ¶
type DisassociateCustomerGatewayInput struct { // The Amazon Resource Name (ARN) of the customer gateway. For more information, // see Resources Defined by Amazon EC2 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies). // // This member is required. CustomerGatewayArn *string // The ID of the global network. // // This member is required. GlobalNetworkId *string }
type DisassociateCustomerGatewayOutput ¶
type DisassociateCustomerGatewayOutput struct { // Information about the customer gateway association. CustomerGatewayAssociation *types.CustomerGatewayAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateLinkInput ¶
type DisassociateLinkInput struct { // The ID of the device. // // This member is required. DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the link. // // This member is required. LinkId *string }
type DisassociateLinkOutput ¶
type DisassociateLinkOutput struct { // Information about the link association. LinkAssociation *types.LinkAssociation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
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 ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetCustomerGatewayAssociationsInput ¶
type GetCustomerGatewayAssociationsInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // One or more customer gateway Amazon Resource Names (ARNs). For more information, // see Resources Defined by Amazon EC2 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies). // The maximum is 10. CustomerGatewayArns []*string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string }
type GetCustomerGatewayAssociationsOutput ¶
type GetCustomerGatewayAssociationsOutput struct { // The customer gateway associations. CustomerGatewayAssociations []*types.CustomerGatewayAssociation // The token for the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDevicesInput ¶
type GetDevicesInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // One or more device IDs. The maximum is 10. DeviceIds []*string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string // The ID of the site. SiteId *string }
type GetDevicesOutput ¶
type GetDevicesOutput struct { // The devices. Devices []*types.Device // The token for the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetLinkAssociationsInput ¶
type GetLinkAssociationsInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the device. DeviceId *string // The ID of the link. LinkId *string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string }
type GetLinkAssociationsOutput ¶
type GetLinkAssociationsOutput struct { // The link associations. LinkAssociations []*types.LinkAssociation // The token for the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetLinksInput ¶
type GetLinksInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // One or more link IDs. The maximum is 10. LinkIds []*string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string // The link provider. Provider *string // The ID of the site. SiteId *string // The link type. Type *string }
type GetLinksOutput ¶
type GetLinksOutput struct { // The links. Links []*types.Link // The token for the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetSitesInput ¶
type GetSitesInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string // One or more site IDs. The maximum is 10. SiteIds []*string }
type GetSitesOutput ¶
type GetSitesOutput struct { // The token for the next page of results. NextToken *string // The sites. Sites []*types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetTransitGatewayRegistrationsInput ¶
type GetTransitGatewayRegistrationsInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The maximum number of results to return. MaxResults *int32 // The token for the next page of results. NextToken *string // The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is // 10. TransitGatewayArns []*string }
type GetTransitGatewayRegistrationsOutput ¶
type GetTransitGatewayRegistrationsOutput struct { // The token for the next page of results. NextToken *string // The transit gateway registrations. TransitGatewayRegistrations []*types.TransitGatewayRegistration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The list of tags. TagList []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // 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 region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type RegisterTransitGatewayInput ¶
type RegisterTransitGatewayInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The Amazon Resource Name (ARN) of the transit gateway. For more information, see // Resources Defined by Amazon EC2 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies). // // This member is required. TransitGatewayArn *string }
type RegisterTransitGatewayOutput ¶
type RegisterTransitGatewayOutput struct { // Information about the transit gateway registration. TransitGatewayRegistration *types.TransitGatewayRegistration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tags to apply to the specified resource. // // This member is required. Tags []*types.Tag }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tag keys to remove from the specified resource. // // This member is required. TagKeys []*string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDeviceInput ¶
type UpdateDeviceInput struct { // The ID of the device. // // This member is required. DeviceId *string // The ID of the global network. // // This member is required. GlobalNetworkId *string // A description of the device. Length Constraints: Maximum length of 256 // characters. Description *string // Describes a location. Location *types.Location // The model of the device. Length Constraints: Maximum length of 128 characters. Model *string // The serial number of the device. Length Constraints: Maximum length of 128 // characters. SerialNumber *string // The ID of the site. SiteId *string // The type of the device. Type *string // The vendor of the device. Length Constraints: Maximum length of 128 characters. Vendor *string }
type UpdateDeviceOutput ¶
type UpdateDeviceOutput struct { // Information about the device. Device *types.Device // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateGlobalNetworkInput ¶
type UpdateGlobalNetworkInput struct { // The ID of your global network. // // This member is required. GlobalNetworkId *string // A description of the global network. Length Constraints: Maximum length of 256 // characters. Description *string }
type UpdateGlobalNetworkOutput ¶
type UpdateGlobalNetworkOutput struct { // Information about the global network object. GlobalNetwork *types.GlobalNetwork // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateLinkInput ¶
type UpdateLinkInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of the link. // // This member is required. LinkId *string // The upload and download speed in Mbps. Bandwidth *types.Bandwidth // A description of the link. Length Constraints: Maximum length of 256 characters. Description *string // The provider of the link. Length Constraints: Maximum length of 128 characters. Provider *string // The type of the link. Length Constraints: Maximum length of 128 characters. Type *string }
type UpdateLinkOutput ¶
type UpdateLinkOutput struct { // Information about the link. Link *types.Link // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateSiteInput ¶
type UpdateSiteInput struct { // The ID of the global network. // // This member is required. GlobalNetworkId *string // The ID of your site. // // This member is required. SiteId *string // A description of your site. Length Constraints: Maximum length of 256 // characters. Description *string // The site location: // // * Address: The physical address of the site. // // * Latitude: // The latitude of the site. // // * Longitude: The longitude of the site. Location *types.Location }
type UpdateSiteOutput ¶
type UpdateSiteOutput struct { // Information about the site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AssociateCustomerGateway.go api_op_AssociateLink.go api_op_CreateDevice.go api_op_CreateGlobalNetwork.go api_op_CreateLink.go api_op_CreateSite.go api_op_DeleteDevice.go api_op_DeleteGlobalNetwork.go api_op_DeleteLink.go api_op_DeleteSite.go api_op_DeregisterTransitGateway.go api_op_DescribeGlobalNetworks.go api_op_DisassociateCustomerGateway.go api_op_DisassociateLink.go api_op_GetCustomerGatewayAssociations.go api_op_GetDevices.go api_op_GetLinkAssociations.go api_op_GetLinks.go api_op_GetSites.go api_op_GetTransitGatewayRegistrations.go api_op_ListTagsForResource.go api_op_RegisterTransitGateway.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateDevice.go api_op_UpdateGlobalNetwork.go api_op_UpdateLink.go api_op_UpdateSite.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.29.0
- Published
- Oct 31, 2020
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.