Documentation ¶
Overview ¶
Package kafka provides the API client, operations, and parameter types for Managed Streaming for Kafka.
The operations for managing an Amazon MSK cluster.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type Client
- func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
- func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigurationInput, ...) (*CreateConfigurationOutput, error)
- func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
- func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)
- func (c *Client) DescribeClusterOperation(ctx context.Context, params *DescribeClusterOperationInput, ...) (*DescribeClusterOperationOutput, error)
- func (c *Client) DescribeConfiguration(ctx context.Context, params *DescribeConfigurationInput, ...) (*DescribeConfigurationOutput, error)
- func (c *Client) DescribeConfigurationRevision(ctx context.Context, params *DescribeConfigurationRevisionInput, ...) (*DescribeConfigurationRevisionOutput, error)
- func (c *Client) GetBootstrapBrokers(ctx context.Context, params *GetBootstrapBrokersInput, ...) (*GetBootstrapBrokersOutput, error)
- func (c *Client) GetCompatibleKafkaVersions(ctx context.Context, params *GetCompatibleKafkaVersionsInput, ...) (*GetCompatibleKafkaVersionsOutput, error)
- func (c *Client) ListClusterOperations(ctx context.Context, params *ListClusterOperationsInput, ...) (*ListClusterOperationsOutput, error)
- func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)
- func (c *Client) ListConfigurationRevisions(ctx context.Context, params *ListConfigurationRevisionsInput, ...) (*ListConfigurationRevisionsOutput, error)
- func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurationsInput, optFns ...func(*Options)) (*ListConfigurationsOutput, error)
- func (c *Client) ListKafkaVersions(ctx context.Context, params *ListKafkaVersionsInput, optFns ...func(*Options)) (*ListKafkaVersionsOutput, error)
- func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns ...func(*Options)) (*ListNodesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) RebootBroker(ctx context.Context, params *RebootBrokerInput, optFns ...func(*Options)) (*RebootBrokerOutput, 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) UpdateBrokerCount(ctx context.Context, params *UpdateBrokerCountInput, optFns ...func(*Options)) (*UpdateBrokerCountOutput, error)
- func (c *Client) UpdateBrokerStorage(ctx context.Context, params *UpdateBrokerStorageInput, ...) (*UpdateBrokerStorageOutput, error)
- func (c *Client) UpdateClusterConfiguration(ctx context.Context, params *UpdateClusterConfigurationInput, ...) (*UpdateClusterConfigurationOutput, error)
- func (c *Client) UpdateClusterKafkaVersion(ctx context.Context, params *UpdateClusterKafkaVersionInput, ...) (*UpdateClusterKafkaVersionOutput, error)
- func (c *Client) UpdateMonitoring(ctx context.Context, params *UpdateMonitoringInput, optFns ...func(*Options)) (*UpdateMonitoringOutput, error)
- type CreateClusterInput
- type CreateClusterOutput
- type CreateConfigurationInput
- type CreateConfigurationOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DescribeClusterInput
- type DescribeClusterOperationInput
- type DescribeClusterOperationOutput
- type DescribeClusterOutput
- type DescribeConfigurationInput
- type DescribeConfigurationOutput
- type DescribeConfigurationRevisionInput
- type DescribeConfigurationRevisionOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetBootstrapBrokersInput
- type GetBootstrapBrokersOutput
- type GetCompatibleKafkaVersionsInput
- type GetCompatibleKafkaVersionsOutput
- type HTTPClient
- type HTTPSignerV4
- type ListClusterOperationsInput
- type ListClusterOperationsOutput
- type ListClustersInput
- type ListClustersOutput
- type ListConfigurationRevisionsInput
- type ListConfigurationRevisionsOutput
- type ListConfigurationsInput
- type ListConfigurationsOutput
- type ListKafkaVersionsInput
- type ListKafkaVersionsOutput
- type ListNodesInput
- type ListNodesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type RebootBrokerInput
- type RebootBrokerOutput
- type ResolveEndpoint
- type ResolverOptions
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateBrokerCountInput
- type UpdateBrokerCountOutput
- type UpdateBrokerStorageInput
- type UpdateBrokerStorageOutput
- type UpdateClusterConfigurationInput
- type UpdateClusterConfigurationOutput
- type UpdateClusterKafkaVersionInput
- type UpdateClusterKafkaVersionOutput
- type UpdateMonitoringInput
- type UpdateMonitoringOutput
Constants ¶
const ServiceAPIVersion = "2018-11-14"
const ServiceID = "Kafka"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Managed Streaming for Kafka.
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) CreateCluster ¶
func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)
Creates a new MSK cluster.
func (*Client) CreateConfiguration ¶
func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigurationInput, optFns ...func(*Options)) (*CreateConfigurationOutput, error)
Creates a new MSK configuration.
func (*Client) DeleteCluster ¶
func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
func (*Client) DescribeCluster ¶
func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
func (*Client) DescribeClusterOperation ¶
func (c *Client) DescribeClusterOperation(ctx context.Context, params *DescribeClusterOperationInput, optFns ...func(*Options)) (*DescribeClusterOperationOutput, error)
Returns a description of the cluster operation specified by the ARN.
func (*Client) DescribeConfiguration ¶
func (c *Client) DescribeConfiguration(ctx context.Context, params *DescribeConfigurationInput, optFns ...func(*Options)) (*DescribeConfigurationOutput, error)
Returns a description of this MSK configuration.
func (*Client) DescribeConfigurationRevision ¶
func (c *Client) DescribeConfigurationRevision(ctx context.Context, params *DescribeConfigurationRevisionInput, optFns ...func(*Options)) (*DescribeConfigurationRevisionOutput, error)
Returns a description of this revision of the configuration.
func (*Client) GetBootstrapBrokers ¶
func (c *Client) GetBootstrapBrokers(ctx context.Context, params *GetBootstrapBrokersInput, optFns ...func(*Options)) (*GetBootstrapBrokersOutput, error)
A list of brokers that a client application can use to bootstrap.
func (*Client) GetCompatibleKafkaVersions ¶
func (c *Client) GetCompatibleKafkaVersions(ctx context.Context, params *GetCompatibleKafkaVersionsInput, optFns ...func(*Options)) (*GetCompatibleKafkaVersionsOutput, error)
Gets the Apache Kafka versions to which you can update the MSK cluster.
func (*Client) ListClusterOperations ¶
func (c *Client) ListClusterOperations(ctx context.Context, params *ListClusterOperationsInput, optFns ...func(*Options)) (*ListClusterOperationsOutput, error)
Returns a list of all the operations that have been performed on the specified MSK cluster.
func (*Client) ListClusters ¶
func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)
Returns a list of all the MSK clusters in the current Region.
func (*Client) ListConfigurationRevisions ¶
func (c *Client) ListConfigurationRevisions(ctx context.Context, params *ListConfigurationRevisionsInput, optFns ...func(*Options)) (*ListConfigurationRevisionsOutput, error)
Returns a list of all the MSK configurations in this Region.
func (*Client) ListConfigurations ¶
func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurationsInput, optFns ...func(*Options)) (*ListConfigurationsOutput, error)
Returns a list of all the MSK configurations in this Region.
func (*Client) ListKafkaVersions ¶
func (c *Client) ListKafkaVersions(ctx context.Context, params *ListKafkaVersionsInput, optFns ...func(*Options)) (*ListKafkaVersionsOutput, error)
Returns a list of Kafka versions.
func (*Client) ListNodes ¶
func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns ...func(*Options)) (*ListNodesOutput, error)
Returns a list of the broker nodes in the cluster.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns a list of the tags associated with the specified resource.
func (*Client) RebootBroker ¶
func (c *Client) RebootBroker(ctx context.Context, params *RebootBrokerInput, optFns ...func(*Options)) (*RebootBrokerOutput, error)
Reboots brokers.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds tags to the specified MSK resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the tags associated with the keys that are provided in the query.
func (*Client) UpdateBrokerCount ¶
func (c *Client) UpdateBrokerCount(ctx context.Context, params *UpdateBrokerCountInput, optFns ...func(*Options)) (*UpdateBrokerCountOutput, error)
Updates the number of broker nodes in the cluster.
func (*Client) UpdateBrokerStorage ¶
func (c *Client) UpdateBrokerStorage(ctx context.Context, params *UpdateBrokerStorageInput, optFns ...func(*Options)) (*UpdateBrokerStorageOutput, error)
Updates the EBS storage associated with MSK brokers.
func (*Client) UpdateClusterConfiguration ¶
func (c *Client) UpdateClusterConfiguration(ctx context.Context, params *UpdateClusterConfigurationInput, optFns ...func(*Options)) (*UpdateClusterConfigurationOutput, error)
Updates the cluster with the configuration that is specified in the request body.
func (*Client) UpdateClusterKafkaVersion ¶
func (c *Client) UpdateClusterKafkaVersion(ctx context.Context, params *UpdateClusterKafkaVersionInput, optFns ...func(*Options)) (*UpdateClusterKafkaVersionOutput, error)
Updates the Apache Kafka version for the cluster.
func (*Client) UpdateMonitoring ¶
func (c *Client) UpdateMonitoring(ctx context.Context, params *UpdateMonitoringInput, optFns ...func(*Options)) (*UpdateMonitoringOutput, error)
Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
type CreateClusterInput ¶
type CreateClusterInput struct { // Information about the broker nodes in the cluster. // // This member is required. BrokerNodeGroupInfo *types.BrokerNodeGroupInfo // The name of the cluster. // // This member is required. ClusterName *string // The version of Apache Kafka. // // This member is required. KafkaVersion *string // The number of broker nodes in the cluster. // // This member is required. NumberOfBrokerNodes *int32 // Includes all client authentication related information. ClientAuthentication *types.ClientAuthentication // Represents the configuration that you want MSK to use for the brokers in a // cluster. ConfigurationInfo *types.ConfigurationInfo // Includes all encryption-related information. EncryptionInfo *types.EncryptionInfo // Specifies the level of monitoring for the MSK cluster. The possible values are // DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. EnhancedMonitoring types.EnhancedMonitoring LoggingInfo *types.LoggingInfo // The settings for open monitoring. OpenMonitoring *types.OpenMonitoringInfo // Create tags when creating the cluster. Tags map[string]*string }
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The name of the MSK cluster. ClusterName *string // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. State types.ClusterState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateConfigurationInput ¶
type CreateConfigurationInput struct { // The name of the configuration. // // This member is required. Name *string // Contents of the server.properties file. When using the API, you must ensure that // the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in // plaintext. // // This member is required. ServerProperties []byte // The description of the configuration. Description *string // The versions of Apache Kafka with which you can use this MSK configuration. KafkaVersions []*string }
type CreateConfigurationOutput ¶
type CreateConfigurationOutput struct { // The Amazon Resource Name (ARN) of the configuration. Arn *string // The time when the configuration was created. CreationTime *time.Time // Latest revision of the configuration. LatestRevision *types.ConfigurationRevision // The name of the configuration. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteClusterInput ¶
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. State types.ClusterState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeClusterInput ¶
type DescribeClusterInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string }
type DescribeClusterOperationInput ¶
type DescribeClusterOperationInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster // operation. // // This member is required. ClusterOperationArn *string }
type DescribeClusterOperationOutput ¶
type DescribeClusterOperationOutput struct { // Cluster operation information ClusterOperationInfo *types.ClusterOperationInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeClusterOutput ¶
type DescribeClusterOutput struct { // The cluster information. ClusterInfo *types.ClusterInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeConfigurationInput ¶
type DescribeConfigurationInput struct { // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and // all of its revisions. // // This member is required. Arn *string }
type DescribeConfigurationOutput ¶
type DescribeConfigurationOutput struct { // The Amazon Resource Name (ARN) of the configuration. Arn *string // The time when the configuration was created. CreationTime *time.Time // The description of the configuration. Description *string // The versions of Apache Kafka with which you can use this MSK configuration. KafkaVersions []*string // Latest revision of the configuration. LatestRevision *types.ConfigurationRevision // The name of the configuration. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeConfigurationRevisionInput ¶
type DescribeConfigurationRevisionInput struct { // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and // all of its revisions. // // This member is required. Arn *string // A string that uniquely identifies a revision of an MSK configuration. // // This member is required. Revision *int64 }
type DescribeConfigurationRevisionOutput ¶
type DescribeConfigurationRevisionOutput struct { // The Amazon Resource Name (ARN) of the configuration. Arn *string // The time when the configuration was created. CreationTime *time.Time // The description of the configuration. Description *string // The revision number. Revision *int64 // Contents of the server.properties file. When using the API, you must ensure that // the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in // plaintext. ServerProperties []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options ResolverOptions) (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 ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type GetBootstrapBrokersInput ¶
type GetBootstrapBrokersInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string }
type GetBootstrapBrokersOutput ¶
type GetBootstrapBrokersOutput struct { // A string containing one or more hostname:port pairs. BootstrapBrokerString *string // A string containing one or more DNS names (or IP) and TLS port pairs. BootstrapBrokerStringTls *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetCompatibleKafkaVersionsInput ¶
type GetCompatibleKafkaVersionsInput struct { // The Amazon Resource Name (ARN) of the cluster check. ClusterArn *string }
type GetCompatibleKafkaVersionsOutput ¶
type GetCompatibleKafkaVersionsOutput struct { // A list of CompatibleKafkaVersion objects. CompatibleKafkaVersions []*types.CompatibleKafkaVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPSignerV4 ¶
type ListClusterOperationsInput ¶
type ListClusterOperationsInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListClusterOperationsOutput ¶
type ListClusterOperationsOutput struct { // An array of cluster operation information objects. ClusterOperationInfoList []*types.ClusterOperationInfo // If the response of ListClusterOperations is truncated, it returns a NextToken in // the response. This Nexttoken should be sent in the subsequent request to // ListClusterOperations. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListClustersInput ¶
type ListClustersInput struct { // Specify a prefix of the name of the clusters that you want to list. The service // lists all the clusters whose names start with this prefix. ClusterNameFilter *string // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListClustersOutput ¶
type ListClustersOutput struct { // Information on each of the MSK clusters in the response. ClusterInfoList []*types.ClusterInfo // The paginated results marker. When the result of a ListClusters operation is // truncated, the call returns NextToken in the response. To get another batch of // clusters, provide this token in your next request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListConfigurationRevisionsInput ¶
type ListConfigurationRevisionsInput struct { // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and // all of its revisions. // // This member is required. Arn *string // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListConfigurationRevisionsOutput ¶
type ListConfigurationRevisionsOutput struct { // Paginated results marker. NextToken *string // List of ConfigurationRevision objects. Revisions []*types.ConfigurationRevision // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListConfigurationsInput ¶
type ListConfigurationsInput struct { // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListConfigurationsOutput ¶
type ListConfigurationsOutput struct { // An array of MSK configurations. Configurations []*types.Configuration // The paginated results marker. When the result of a ListConfigurations operation // is truncated, the call returns NextToken in the response. To get another batch // of configurations, provide this token in your next request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListKafkaVersionsInput ¶
type ListKafkaVersionsInput struct { // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListKafkaVersionsOutput ¶
type ListKafkaVersionsOutput struct { KafkaVersions []*types.KafkaVersion NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListNodesInput ¶
type ListNodesInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // The maximum number of results to return in the response. If there are more // results, the response includes a NextToken parameter. MaxResults *int32 // The paginated results marker. When the result of the operation is truncated, the // call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string }
type ListNodesOutput ¶
type ListNodesOutput struct { // The paginated results marker. When the result of a ListNodes operation is // truncated, the call returns NextToken in the response. To get another batch of // nodes, provide this token in your next request. NextToken *string // List containing a NodeInfo object. NodeInfoList []*types.NodeInfo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the resource that's // associated with the tags. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The key-value pair for the resource tag. Tags map[string]*string // 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 ResolverOptions // 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 }
type RebootBrokerInput ¶
type RebootBrokerInput struct { // The list of broker IDs to be rebooted. // // This member is required. BrokerIds []*string // The Amazon Resource Name (ARN) of the cluster to be updated. // // This member is required. ClusterArn *string }
Reboots a node.
type RebootBrokerOutput ¶
type RebootBrokerOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
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 ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type TagResourceInput ¶
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) that uniquely identifies the resource that's // associated with the tags. // // This member is required. ResourceArn *string // Tag keys must be unique for a given cluster. In addition, the following // restrictions apply: // // * Each tag key must be unique. If you add a tag with a // key that's already in use, your new tag overwrites the existing key-value // pair. // // * You can't start a tag key with aws: because this prefix is reserved // for use by AWS. AWS creates tags that begin with this prefix on your behalf, but // you can't edit or delete them. // // * Tag keys must be between 1 and 128 Unicode // characters in length. // // * Tag keys must consist of the following characters: // Unicode letters, digits, white space, and the following special characters: _ . // / = + - @. // // This member is required. TagKeys []*string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateBrokerCountInput ¶
type UpdateBrokerCountInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // The version of cluster to update from. A successful operation will then generate // a new version. // // This member is required. CurrentVersion *string // The number of broker nodes that you want the cluster to have after this // operation completes successfully. // // This member is required. TargetNumberOfBrokerNodes *int32 }
type UpdateBrokerCountOutput ¶
type UpdateBrokerCountOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateBrokerStorageInput ¶
type UpdateBrokerStorageInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // The version of cluster to update from. A successful operation will then generate // a new version. // // This member is required. CurrentVersion *string // Describes the target volume size and the ID of the broker to apply the update // to. // // This member is required. TargetBrokerEBSVolumeInfo []*types.BrokerEBSVolumeInfo }
type UpdateBrokerStorageOutput ¶
type UpdateBrokerStorageOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateClusterConfigurationInput ¶
type UpdateClusterConfigurationInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // Represents the configuration that you want MSK to use for the brokers in a // cluster. // // This member is required. ConfigurationInfo *types.ConfigurationInfo // The version of the cluster that needs to be updated. // // This member is required. CurrentVersion *string }
type UpdateClusterConfigurationOutput ¶
type UpdateClusterConfigurationOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateClusterKafkaVersionInput ¶
type UpdateClusterKafkaVersionInput struct { // The Amazon Resource Name (ARN) of the cluster to be updated. // // This member is required. ClusterArn *string // Current cluster version. // // This member is required. CurrentVersion *string // Target Kafka version. // // This member is required. TargetKafkaVersion *string // The custom configuration that should be applied on the new version of cluster. ConfigurationInfo *types.ConfigurationInfo }
type UpdateClusterKafkaVersionOutput ¶
type UpdateClusterKafkaVersionOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateMonitoringInput ¶
type UpdateMonitoringInput struct { // The Amazon Resource Name (ARN) that uniquely identifies the cluster. // // This member is required. ClusterArn *string // The version of the MSK cluster to update. Cluster versions aren't simple // numbers. You can describe an MSK cluster to find its version. When this update // operation is successful, it generates a new cluster version. // // This member is required. CurrentVersion *string // Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon // CloudWatch for this cluster. EnhancedMonitoring types.EnhancedMonitoring LoggingInfo *types.LoggingInfo // The settings for open monitoring. OpenMonitoring *types.OpenMonitoringInfo }
Request body for UpdateMonitoring.
type UpdateMonitoringOutput ¶
type UpdateMonitoringOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string // The Amazon Resource Name (ARN) of the cluster operation. ClusterOperationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
- api_client.go
- api_op_CreateCluster.go
- api_op_CreateConfiguration.go
- api_op_DeleteCluster.go
- api_op_DescribeCluster.go
- api_op_DescribeClusterOperation.go
- api_op_DescribeConfiguration.go
- api_op_DescribeConfigurationRevision.go
- api_op_GetBootstrapBrokers.go
- api_op_GetCompatibleKafkaVersions.go
- api_op_ListClusterOperations.go
- api_op_ListClusters.go
- api_op_ListConfigurationRevisions.go
- api_op_ListConfigurations.go
- api_op_ListKafkaVersions.go
- api_op_ListNodes.go
- api_op_ListTagsForResource.go
- api_op_RebootBroker.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateBrokerCount.go
- api_op_UpdateBrokerStorage.go
- api_op_UpdateClusterConfiguration.go
- api_op_UpdateClusterKafkaVersion.go
- api_op_UpdateMonitoring.go
- deserializers.go
- doc.go
- endpoints.go
- serializers.go
- validators.go