kafka

package module
v1.19.11 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: Apache-2.0 Imports: 34 Imported by: 37

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

View Source 
const ServiceAPIVersion = "2018-11-14"
View Source 
const ServiceID = "Kafka"

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 BatchAssociateScramSecretInput added in v0.29.0 

type BatchAssociateScramSecretInput struct {

	// The Amazon Resource Name (ARN) of the cluster to be updated.
	//
	// This member is required.
	ClusterArn *string

	// List of AWS Secrets Manager secret ARNs.
	//
	// This member is required.
	SecretArnList []string
	// contains filtered or unexported fields
}

Associates sasl scram secrets to cluster.

type BatchAssociateScramSecretOutput added in v0.29.0 

type BatchAssociateScramSecretOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// List of errors when associating secrets to cluster.
	UnprocessedScramSecrets []types.UnprocessedScramSecret

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

type BatchDisassociateScramSecretInput added in v0.29.0 

type BatchDisassociateScramSecretInput struct {

	// The Amazon Resource Name (ARN) of the cluster to be updated.
	//
	// This member is required.
	ClusterArn *string

	// List of AWS Secrets Manager secret ARNs.
	//
	// This member is required.
	SecretArnList []string
	// contains filtered or unexported fields
}

Disassociates sasl scram secrets to cluster.

type BatchDisassociateScramSecretOutput added in v0.29.0 

type BatchDisassociateScramSecretOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// List of errors when disassociating secrets to cluster.
	UnprocessedScramSecrets []types.UnprocessedScramSecret

	// 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 Managed Streaming for Kafka.

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) BatchAssociateScramSecret added in v0.29.0 

func (c *Client) BatchAssociateScramSecret(ctx context.Context, params *BatchAssociateScramSecretInput, optFns ...func(*Options)) (*BatchAssociateScramSecretOutput, error)

Associates one or more Scram Secrets with an Amazon MSK cluster.

func (*Client) BatchDisassociateScramSecret added in v0.29.0 

func (c *Client) BatchDisassociateScramSecret(ctx context.Context, params *BatchDisassociateScramSecretInput, optFns ...func(*Options)) (*BatchDisassociateScramSecretOutput, error)

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

func (*Client) CreateCluster 

func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)

Creates a new MSK cluster.

func (*Client) CreateClusterV2 added in v1.11.0 

func (c *Client) CreateClusterV2(ctx context.Context, params *CreateClusterV2Input, optFns ...func(*Options)) (*CreateClusterV2Output, 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) DeleteConfiguration added in v0.29.0 

func (c *Client) DeleteConfiguration(ctx context.Context, params *DeleteConfigurationInput, optFns ...func(*Options)) (*DeleteConfigurationOutput, error)

Deletes an MSK Configuration.

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) DescribeClusterV2 added in v1.11.0 

func (c *Client) DescribeClusterV2(ctx context.Context, params *DescribeClusterV2Input, optFns ...func(*Options)) (*DescribeClusterV2Output, error)

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

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) ListClustersV2 added in v1.11.0 

func (c *Client) ListClustersV2(ctx context.Context, params *ListClustersV2Input, optFns ...func(*Options)) (*ListClustersV2Output, 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 Apache 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) ListScramSecrets added in v0.29.0 

func (c *Client) ListScramSecrets(ctx context.Context, params *ListScramSecretsInput, optFns ...func(*Options)) (*ListScramSecretsOutput, error)

Returns a list of the Scram Secrets associated with an Amazon MSK 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) UpdateBrokerType added in v1.2.0 

func (c *Client) UpdateBrokerType(ctx context.Context, params *UpdateBrokerTypeInput, optFns ...func(*Options)) (*UpdateBrokerTypeOutput, error)

Updates EC2 instance type.

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) UpdateConfiguration added in v0.29.0 

func (c *Client) UpdateConfiguration(ctx context.Context, params *UpdateConfigurationInput, optFns ...func(*Options)) (*UpdateConfigurationOutput, error)

Updates an MSK configuration.

func (*Client) UpdateConnectivity added in v1.10.0 

func (c *Client) UpdateConnectivity(ctx context.Context, params *UpdateConnectivityInput, optFns ...func(*Options)) (*UpdateConnectivityOutput, error)

Updates the cluster's connectivity configuration.

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.

func (*Client) UpdateSecurity added in v1.7.0 

func (c *Client) UpdateSecurity(ctx context.Context, params *UpdateSecurityInput, optFns ...func(*Options)) (*UpdateSecurityOutput, error)

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

func (*Client) UpdateStorage added in v1.18.0 

func (c *Client) UpdateStorage(ctx context.Context, params *UpdateStorageInput, optFns ...func(*Options)) (*UpdateStorageOutput, error)

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

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, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
	EnhancedMonitoring types.EnhancedMonitoring

	LoggingInfo *types.LoggingInfo

	// The settings for open monitoring.
	OpenMonitoring *types.OpenMonitoringInfo

	// This controls storage mode for supported storage tiers.
	StorageMode types.StorageMode

	// Create tags when creating the cluster.
	Tags map[string]string
	// contains filtered or unexported fields
}

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 ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State types.ClusterState

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

type CreateClusterV2Input added in v1.11.0 

type CreateClusterV2Input struct {

	// The name of the cluster.
	//
	// This member is required.
	ClusterName *string

	// Information about the provisioned cluster.
	Provisioned *types.ProvisionedRequest

	// Information about the serverless cluster.
	Serverless *types.ServerlessRequest

	// A map of tags that you want the cluster to have.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateClusterV2Output added in v1.11.0 

type CreateClusterV2Output struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// The name of the MSK cluster.
	ClusterName *string

	// The type of the cluster. The possible states are PROVISIONED or SERVERLESS.
	ClusterType types.ClusterType

	// The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State types.ClusterState

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

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
	// contains filtered or unexported fields
}

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

	// The state of the configuration. The possible states are ACTIVE, DELETING, and
	// DELETE_FAILED.
	State types.ConfigurationState

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

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	//
	// This member is required.
	ClusterArn *string

	// The current version of the MSK cluster.
	CurrentVersion *string
	// contains filtered or unexported fields
}

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string

	// The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State types.ClusterState

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

type DeleteConfigurationInput added in v0.29.0 

type DeleteConfigurationInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteConfigurationOutput added in v0.29.0 

type DeleteConfigurationOutput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
	Arn *string

	// The state of the configuration. The possible states are ACTIVE, DELETING, and
	// DELETE_FAILED.
	State types.ConfigurationState

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

type DescribeClusterInput 

type DescribeClusterInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	//
	// This member is required.
	ClusterArn *string
	// contains filtered or unexported fields
}

type DescribeClusterOperationInput 

type DescribeClusterOperationInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster
	// operation.
	//
	// This member is required.
	ClusterOperationArn *string
	// contains filtered or unexported fields
}

type DescribeClusterOperationOutput 

type DescribeClusterOperationOutput struct {

	// Cluster operation information
	ClusterOperationInfo *types.ClusterOperationInfo

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

type DescribeClusterOutput 

type DescribeClusterOutput struct {

	// The cluster information.
	ClusterInfo *types.ClusterInfo

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

type DescribeClusterV2Input added in v1.11.0 

type DescribeClusterV2Input struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	//
	// This member is required.
	ClusterArn *string
	// contains filtered or unexported fields
}

type DescribeClusterV2Output added in v1.11.0 

type DescribeClusterV2Output struct {

	// The cluster information.
	ClusterInfo *types.Cluster

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

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
	// contains filtered or unexported fields
}

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

	// The state of the configuration. The possible states are ACTIVE, DELETING, and
	// DELETE_FAILED.
	State types.ConfigurationState

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

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
	// contains filtered or unexported fields
}

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

type GetBootstrapBrokersInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	//
	// This member is required.
	ClusterArn *string
	// contains filtered or unexported fields
}

type GetBootstrapBrokersOutput 

type GetBootstrapBrokersOutput struct {

	// A string containing one or more hostname:port pairs.
	BootstrapBrokerString *string

	// A string that contains one or more DNS names (or IP addresses) and SASL IAM
	// port pairs.
	BootstrapBrokerStringPublicSaslIam *string

	// A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
	BootstrapBrokerStringPublicSaslScram *string

	// A string containing one or more DNS names (or IP) and TLS port pairs.
	BootstrapBrokerStringPublicTls *string

	// A string that contains one or more DNS names (or IP addresses) and SASL IAM
	// port pairs.
	BootstrapBrokerStringSaslIam *string

	// A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
	BootstrapBrokerStringSaslScram *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
	// contains filtered or unexported fields
}

type GetCompatibleKafkaVersionsInput 

type GetCompatibleKafkaVersionsInput struct {

	// The Amazon Resource Name (ARN) of the cluster check.
	ClusterArn *string
	// contains filtered or unexported fields
}

type GetCompatibleKafkaVersionsOutput 

type GetCompatibleKafkaVersionsOutput struct {

	// A list of CompatibleKafkaVersion objects.
	CompatibleKafkaVersions []types.CompatibleKafkaVersion

	// 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 ListClusterOperationsAPIClient added in v0.30.0 

type ListClusterOperationsAPIClient interface {
	ListClusterOperations(context.Context, *ListClusterOperationsInput, ...func(*Options)) (*ListClusterOperationsOutput, error)
}

ListClusterOperationsAPIClient is a client that implements the ListClusterOperations operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListClusterOperationsPaginator added in v0.30.0 

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

ListClusterOperationsPaginator is a paginator for ListClusterOperations

func NewListClusterOperationsPaginator added in v0.30.0 

func NewListClusterOperationsPaginator(client ListClusterOperationsAPIClient, params *ListClusterOperationsInput, optFns ...func(*ListClusterOperationsPaginatorOptions)) *ListClusterOperationsPaginator

NewListClusterOperationsPaginator returns a new ListClusterOperationsPaginator

func (*ListClusterOperationsPaginator) HasMorePages added in v0.30.0 

func (p *ListClusterOperationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClusterOperationsPaginator) NextPage added in v0.30.0 

func (p *ListClusterOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClusterOperationsOutput, error)

NextPage retrieves the next ListClusterOperations page.

type ListClusterOperationsPaginatorOptions added in v0.30.0 

type ListClusterOperationsPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListClusterOperationsPaginatorOptions is the paginator options for ListClusterOperations

type ListClustersAPIClient added in v0.30.0 

type ListClustersAPIClient interface {
	ListClusters(context.Context, *ListClustersInput, ...func(*Options)) (*ListClustersOutput, error)
}

ListClustersAPIClient is a client that implements the ListClusters operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListClustersPaginator added in v0.30.0 

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

ListClustersPaginator is a paginator for ListClusters

func NewListClustersPaginator added in v0.30.0 

func NewListClustersPaginator(client ListClustersAPIClient, params *ListClustersInput, optFns ...func(*ListClustersPaginatorOptions)) *ListClustersPaginator

NewListClustersPaginator returns a new ListClustersPaginator

func (*ListClustersPaginator) HasMorePages added in v0.30.0 

func (p *ListClustersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClustersPaginator) NextPage added in v0.30.0 

func (p *ListClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersOutput, error)

NextPage retrieves the next ListClusters page.

type ListClustersPaginatorOptions added in v0.30.0 

type ListClustersPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListClustersPaginatorOptions is the paginator options for ListClusters

type ListClustersV2APIClient added in v1.11.0 

type ListClustersV2APIClient interface {
	ListClustersV2(context.Context, *ListClustersV2Input, ...func(*Options)) (*ListClustersV2Output, error)
}

ListClustersV2APIClient is a client that implements the ListClustersV2 operation.

type ListClustersV2Input added in v1.11.0 

type ListClustersV2Input struct {

	// Specify a prefix of the names of the clusters that you want to list. The
	// service lists all the clusters whose names start with this prefix.
	ClusterNameFilter *string

	// Specify either PROVISIONED or SERVERLESS.
	ClusterTypeFilter *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
	// contains filtered or unexported fields
}

type ListClustersV2Output added in v1.11.0 

type ListClustersV2Output struct {

	// Information on each of the MSK clusters in the response.
	ClusterInfoList []types.Cluster

	// 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
	// contains filtered or unexported fields
}

type ListClustersV2Paginator added in v1.11.0 

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

ListClustersV2Paginator is a paginator for ListClustersV2

func NewListClustersV2Paginator added in v1.11.0 

func NewListClustersV2Paginator(client ListClustersV2APIClient, params *ListClustersV2Input, optFns ...func(*ListClustersV2PaginatorOptions)) *ListClustersV2Paginator

NewListClustersV2Paginator returns a new ListClustersV2Paginator

func (*ListClustersV2Paginator) HasMorePages added in v1.11.0 

func (p *ListClustersV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClustersV2Paginator) NextPage added in v1.11.0 

func (p *ListClustersV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersV2Output, error)

NextPage retrieves the next ListClustersV2 page.

type ListClustersV2PaginatorOptions added in v1.11.0 

type ListClustersV2PaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListClustersV2PaginatorOptions is the paginator options for ListClustersV2

type ListConfigurationRevisionsAPIClient added in v0.30.0 

type ListConfigurationRevisionsAPIClient interface {
	ListConfigurationRevisions(context.Context, *ListConfigurationRevisionsInput, ...func(*Options)) (*ListConfigurationRevisionsOutput, error)
}

ListConfigurationRevisionsAPIClient is a client that implements the ListConfigurationRevisions operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListConfigurationRevisionsPaginator added in v0.30.0 

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

ListConfigurationRevisionsPaginator is a paginator for ListConfigurationRevisions

func NewListConfigurationRevisionsPaginator added in v0.30.0 

func NewListConfigurationRevisionsPaginator(client ListConfigurationRevisionsAPIClient, params *ListConfigurationRevisionsInput, optFns ...func(*ListConfigurationRevisionsPaginatorOptions)) *ListConfigurationRevisionsPaginator

NewListConfigurationRevisionsPaginator returns a new ListConfigurationRevisionsPaginator

func (*ListConfigurationRevisionsPaginator) HasMorePages added in v0.30.0 

func (p *ListConfigurationRevisionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfigurationRevisionsPaginator) NextPage added in v0.30.0 

func (p *ListConfigurationRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfigurationRevisionsOutput, error)

NextPage retrieves the next ListConfigurationRevisions page.

type ListConfigurationRevisionsPaginatorOptions added in v0.30.0 

type ListConfigurationRevisionsPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListConfigurationRevisionsPaginatorOptions is the paginator options for ListConfigurationRevisions

type ListConfigurationsAPIClient added in v0.30.0 

type ListConfigurationsAPIClient interface {
	ListConfigurations(context.Context, *ListConfigurationsInput, ...func(*Options)) (*ListConfigurationsOutput, error)
}

ListConfigurationsAPIClient is a client that implements the ListConfigurations operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListConfigurationsPaginator added in v0.30.0 

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

ListConfigurationsPaginator is a paginator for ListConfigurations

func NewListConfigurationsPaginator added in v0.30.0 

func NewListConfigurationsPaginator(client ListConfigurationsAPIClient, params *ListConfigurationsInput, optFns ...func(*ListConfigurationsPaginatorOptions)) *ListConfigurationsPaginator

NewListConfigurationsPaginator returns a new ListConfigurationsPaginator

func (*ListConfigurationsPaginator) HasMorePages added in v0.30.0 

func (p *ListConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfigurationsPaginator) NextPage added in v0.30.0 

func (p *ListConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfigurationsOutput, error)

NextPage retrieves the next ListConfigurations page.

type ListConfigurationsPaginatorOptions added in v0.30.0 

type ListConfigurationsPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListConfigurationsPaginatorOptions is the paginator options for ListConfigurations

type ListKafkaVersionsAPIClient added in v0.30.0 

type ListKafkaVersionsAPIClient interface {
	ListKafkaVersions(context.Context, *ListKafkaVersionsInput, ...func(*Options)) (*ListKafkaVersionsOutput, error)
}

ListKafkaVersionsAPIClient is a client that implements the ListKafkaVersions operation.

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
	// contains filtered or unexported fields
}

type ListKafkaVersionsOutput 

type ListKafkaVersionsOutput struct {
	KafkaVersions []types.KafkaVersion

	NextToken *string

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

type ListKafkaVersionsPaginator added in v0.30.0 

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

ListKafkaVersionsPaginator is a paginator for ListKafkaVersions

func NewListKafkaVersionsPaginator added in v0.30.0 

func NewListKafkaVersionsPaginator(client ListKafkaVersionsAPIClient, params *ListKafkaVersionsInput, optFns ...func(*ListKafkaVersionsPaginatorOptions)) *ListKafkaVersionsPaginator

NewListKafkaVersionsPaginator returns a new ListKafkaVersionsPaginator

func (*ListKafkaVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListKafkaVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKafkaVersionsPaginator) NextPage added in v0.30.0 

func (p *ListKafkaVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKafkaVersionsOutput, error)

NextPage retrieves the next ListKafkaVersions page.

type ListKafkaVersionsPaginatorOptions added in v0.30.0 

type ListKafkaVersionsPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListKafkaVersionsPaginatorOptions is the paginator options for ListKafkaVersions

type ListNodesAPIClient added in v0.30.0 

type ListNodesAPIClient interface {
	ListNodes(context.Context, *ListNodesInput, ...func(*Options)) (*ListNodesOutput, error)
}

ListNodesAPIClient is a client that implements the ListNodes operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListNodesPaginator added in v0.30.0 

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

ListNodesPaginator is a paginator for ListNodes

func NewListNodesPaginator added in v0.30.0 

func NewListNodesPaginator(client ListNodesAPIClient, params *ListNodesInput, optFns ...func(*ListNodesPaginatorOptions)) *ListNodesPaginator

NewListNodesPaginator returns a new ListNodesPaginator

func (*ListNodesPaginator) HasMorePages added in v0.30.0 

func (p *ListNodesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNodesPaginator) NextPage added in v0.30.0 

func (p *ListNodesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNodesOutput, error)

NextPage retrieves the next ListNodes page.

type ListNodesPaginatorOptions added in v0.30.0 

type ListNodesPaginatorOptions struct {
	// The maximum number of results to return in the response. If there are more
	// results, the response includes a NextToken parameter.
	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
}

ListNodesPaginatorOptions is the paginator options for ListNodes

type ListScramSecretsAPIClient added in v0.30.0 

type ListScramSecretsAPIClient interface {
	ListScramSecrets(context.Context, *ListScramSecretsInput, ...func(*Options)) (*ListScramSecretsOutput, error)
}

ListScramSecretsAPIClient is a client that implements the ListScramSecrets operation.

type ListScramSecretsInput added in v0.29.0 

type ListScramSecretsInput struct {

	// The arn of the cluster.
	//
	// This member is required.
	ClusterArn *string

	// The maxResults of the query.
	MaxResults int32

	// The nextToken of the query.
	NextToken *string
	// contains filtered or unexported fields
}

type ListScramSecretsOutput added in v0.29.0 

type ListScramSecretsOutput struct {

	// Paginated results marker.
	NextToken *string

	// The list of scram secrets associated with the cluster.
	SecretArnList []string

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

type ListScramSecretsPaginator added in v0.30.0 

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

ListScramSecretsPaginator is a paginator for ListScramSecrets

func NewListScramSecretsPaginator added in v0.30.0 

func NewListScramSecretsPaginator(client ListScramSecretsAPIClient, params *ListScramSecretsInput, optFns ...func(*ListScramSecretsPaginatorOptions)) *ListScramSecretsPaginator

NewListScramSecretsPaginator returns a new ListScramSecretsPaginator

func (*ListScramSecretsPaginator) HasMorePages added in v0.30.0 

func (p *ListScramSecretsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScramSecretsPaginator) NextPage added in v0.30.0 

func (p *ListScramSecretsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListScramSecretsOutput, error)

NextPage retrieves the next ListScramSecrets page.

type ListScramSecretsPaginatorOptions added in v0.30.0 

type ListScramSecretsPaginatorOptions struct {
	// The maxResults of the query.
	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
}

ListScramSecretsPaginatorOptions is the paginator options for ListScramSecrets

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 RebootBrokerInput 

type RebootBrokerInput struct {

	// The list of broker IDs to be rebooted. The reboot-broker operation supports
	// rebooting one broker at a time.
	//
	// This member is required.
	BrokerIds []string

	// The Amazon Resource Name (ARN) of the cluster to be updated.
	//
	// This member is required.
	ClusterArn *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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) that uniquely identifies the resource that's
	// associated with the tags.
	//
	// This member is required.
	ResourceArn *string

	// The key-value pair for the resource tag.
	//
	// This member is required.
	Tags map[string]string
	// 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) 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
	// 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
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateBrokerTypeInput added in v1.2.0 

type UpdateBrokerTypeInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	//
	// This member is required.
	ClusterArn *string

	// The cluster version that you want to change. After this operation completes
	// successfully, the cluster will have a new version.
	//
	// This member is required.
	CurrentVersion *string

	// The Amazon MSK broker type that you want all of the brokers in this cluster to
	// be.
	//
	// This member is required.
	TargetInstanceType *string
	// contains filtered or unexported fields
}

type UpdateBrokerTypeOutput added in v1.2.0 

type UpdateBrokerTypeOutput 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateConfigurationInput added in v0.29.0 

type UpdateConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	//
	// This member is required.
	Arn *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 revision.
	Description *string
	// contains filtered or unexported fields
}

type UpdateConfigurationOutput added in v0.29.0 

type UpdateConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	Arn *string

	// Latest revision of the configuration.
	LatestRevision *types.ConfigurationRevision

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

type UpdateConnectivityInput added in v1.10.0 

type UpdateConnectivityInput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	//
	// This member is required.
	ClusterArn *string

	// Information about the broker access configuration.
	//
	// This member is required.
	ConnectivityInfo *types.ConnectivityInfo

	// 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
	// contains filtered or unexported fields
}

Request body for UpdateConnectivity.

type UpdateConnectivityOutput added in v1.10.0 

type UpdateConnectivityOutput 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateSecurityInput added in v1.7.0 

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

	// Includes all client authentication related information.
	ClientAuthentication *types.ClientAuthentication

	// Includes all encryption-related information.
	EncryptionInfo *types.EncryptionInfo
	// contains filtered or unexported fields
}

type UpdateSecurityOutput added in v1.7.0 

type UpdateSecurityOutput 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
	// contains filtered or unexported fields
}

type UpdateStorageInput added in v1.18.0 

type UpdateStorageInput struct {

	// The Amazon Resource Name (ARN) of the cluster to be updated.
	//
	// 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

	// EBS volume provisioned throughput information.
	ProvisionedThroughput *types.ProvisionedThroughput

	// Controls storage mode for supported storage tiers.
	StorageMode types.StorageMode

	// size of the EBS volume to update.
	VolumeSizeGB int32
	// contains filtered or unexported fields
}

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

type UpdateStorageOutput added in v1.18.0 

type UpdateStorageOutput 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
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.