kafka

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 45

Documentation

Overview

Package kafka provides the client and types for making API requests to Kafka.

The operations for managing an Amazon MSK cluster.

See https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14 for more information on this service.

See kafka package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kafka/

Using the Client

To use Kafka with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Kafka client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kafka/#New

Index

Constants

View Source 
const (
	ServiceName = "Kafka" // Service's name
	ServiceID   = "Kafka" // Service's identifier
	EndpointsID = "kafka" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Returns information about an error.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Returns information about an error.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// Returns information about an error.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// Returns information about an error.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// Returns information about an error.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Returns information about an error.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Returns information about an error.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// Returns information about an error.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Authentication added in v0.10.0 

type Authentication struct {

	// Details for ClientAuthentication using TLS.
	Tls *Tls `locationName:"tls" type:"structure"`
	// contains filtered or unexported fields
}

Includes all client authentication information.

func (Authentication) MarshalFields added in v0.10.0 

func (s Authentication) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Authentication) String added in v0.10.0 

func (s Authentication) String() string

String returns the string representation

type Broker added in v0.10.0 

type Broker string

Client-broker encryption in transit setting. 

const (
	BrokerTls          Broker = "TLS"
	BrokerTlsPlaintext Broker = "TLS_PLAINTEXT"
	BrokerPlaintext    Broker = "PLAINTEXT"
)

Enum values for Broker

func (Broker) MarshalValue added in v0.10.0 

func (enum Broker) MarshalValue() (string, error)

func (Broker) MarshalValueBuf added in v0.10.0 

func (enum Broker) MarshalValueBuf(b []byte) ([]byte, error)

type BrokerAZDistribution 

type BrokerAZDistribution string

The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among the Availability Zones of your Region. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out. 

const (
	BrokerAZDistributionDefault BrokerAZDistribution = "DEFAULT"
)

Enum values for BrokerAZDistribution

func (BrokerAZDistribution) MarshalValue 

func (enum BrokerAZDistribution) MarshalValue() (string, error)

func (BrokerAZDistribution) MarshalValueBuf 

func (enum BrokerAZDistribution) MarshalValueBuf(b []byte) ([]byte, error)

type BrokerEBSVolumeInfo added in v0.10.0 

type BrokerEBSVolumeInfo struct {

	// The ID of the broker to update.
	//
	// KafkaBrokerNodeId is a required field
	KafkaBrokerNodeId *string `locationName:"kafkaBrokerNodeId" type:"string" required:"true"`

	// Size of the EBS volume to update.
	//
	// VolumeSizeGB is a required field
	VolumeSizeGB *int64 `locationName:"volumeSizeGB" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

func (BrokerEBSVolumeInfo) MarshalFields added in v0.10.0 

func (s BrokerEBSVolumeInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerEBSVolumeInfo) String added in v0.10.0 

func (s BrokerEBSVolumeInfo) String() string

String returns the string representation

func (*BrokerEBSVolumeInfo) Validate added in v0.10.0 

func (s *BrokerEBSVolumeInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BrokerLogs added in v0.20.0 

type BrokerLogs struct {

	// Details of the CloudWatch Logs destination for broker logs.
	CloudWatchLogs *CloudWatchLogs `locationName:"cloudWatchLogs" type:"structure"`

	// Details of the Kinesis Data Firehose delivery stream that is the destination
	// for broker logs.
	Firehose *Firehose `locationName:"firehose" type:"structure"`

	// Details of the Amazon S3 destination for broker logs.
	S3 *S3 `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

The broker logs configuration for this MSK cluster.

func (BrokerLogs) MarshalFields added in v0.20.0 

func (s BrokerLogs) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerLogs) String added in v0.20.0 

func (s BrokerLogs) String() string

String returns the string representation

func (*BrokerLogs) Validate added in v0.20.0 

func (s *BrokerLogs) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BrokerNodeGroupInfo 

type BrokerNodeGroupInfo struct {

	// The distribution of broker nodes across Availability Zones.
	BrokerAZDistribution BrokerAZDistribution `locationName:"brokerAZDistribution" type:"string" enum:"true"`

	// The list of subnets to connect to in the client virtual private cloud (VPC).
	// AWS creates elastic network interfaces inside these subnets. Client applications
	// use elastic network interfaces to produce and consume data. Client subnets
	// can't be in Availability Zone us-east-1e.
	//
	// ClientSubnets is a required field
	ClientSubnets []string `locationName:"clientSubnets" type:"list" required:"true"`

	// The type of Amazon EC2 instances to use for Kafka brokers. The following
	// instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
	// kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
	//
	// InstanceType is a required field
	InstanceType *string `locationName:"instanceType" min:"5" type:"string" required:"true"`

	// The AWS security groups to associate with the elastic network interfaces
	// in order to specify who can connect to and communicate with the Amazon MSK
	// cluster. If you don't specify a security group, Amazon MSK uses the default
	// security group associated with the VPC. If you specify security groups that
	// were shared with you, you must ensure that you have permissions to them.
	// Specifically, you need the ec2:DescribeSecurityGroups permission.
	SecurityGroups []string `locationName:"securityGroups" type:"list"`

	// Contains information about storage volumes attached to MSK broker nodes.
	StorageInfo *StorageInfo `locationName:"storageInfo" type:"structure"`
	// contains filtered or unexported fields
}

Describes the setup to be used for Kafka broker nodes in the cluster.

func (BrokerNodeGroupInfo) MarshalFields 

func (s BrokerNodeGroupInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerNodeGroupInfo) String 

func (s BrokerNodeGroupInfo) String() string

String returns the string representation

func (*BrokerNodeGroupInfo) Validate 

func (s *BrokerNodeGroupInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BrokerNodeInfo 

type BrokerNodeInfo struct {

	// The attached elastic network interface of the broker.
	AttachedENIId *string `locationName:"attachedENIId" type:"string"`

	// The ID of the broker.
	BrokerId *float64 `locationName:"brokerId" type:"double"`

	// The client subnet to which this broker node belongs.
	ClientSubnet *string `locationName:"clientSubnet" type:"string"`

	// The virtual private cloud (VPC) of the client.
	ClientVpcIpAddress *string `locationName:"clientVpcIpAddress" type:"string"`

	// Information about the version of software currently deployed on the Kafka
	// brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo `locationName:"currentBrokerSoftwareInfo" type:"structure"`

	// Endpoints for accessing the broker.
	Endpoints []string `locationName:"endpoints" type:"list"`
	// contains filtered or unexported fields
}

BrokerNodeInfo

func (BrokerNodeInfo) MarshalFields 

func (s BrokerNodeInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerNodeInfo) String 

func (s BrokerNodeInfo) String() string

String returns the string representation

type BrokerSoftwareInfo 

type BrokerSoftwareInfo struct {

	// The Amazon Resource Name (ARN) of the configuration used for the cluster.
	// This field isn't visible in this preview release.
	ConfigurationArn *string `locationName:"configurationArn" type:"string"`

	// The revision of the configuration to use. This field isn't visible in this
	// preview release.
	ConfigurationRevision *int64 `locationName:"configurationRevision" type:"long"`

	// The version of Apache Kafka.
	KafkaVersion *string `locationName:"kafkaVersion" type:"string"`
	// contains filtered or unexported fields
}

Information about the current software installed on the cluster.

func (BrokerSoftwareInfo) MarshalFields 

func (s BrokerSoftwareInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerSoftwareInfo) String 

func (s BrokerSoftwareInfo) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Kafka. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := kafka.New(myConfig)

func (*Client) CreateClusterRequest added in v0.9.0 

func (c *Client) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest

CreateClusterRequest returns a request value for making API operation for Managed Streaming for Kafka.

Creates a new MSK cluster. 

// Example sending a request using CreateClusterRequest.
req := client.CreateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateCluster

func (*Client) CreateConfigurationRequest added in v0.9.0 

func (c *Client) CreateConfigurationRequest(input *CreateConfigurationInput) CreateConfigurationRequest

CreateConfigurationRequest returns a request value for making API operation for Managed Streaming for Kafka.

Creates a new MSK configuration. 

// Example sending a request using CreateConfigurationRequest.
req := client.CreateConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateConfiguration

func (*Client) DeleteClusterRequest added in v0.9.0 

func (c *Client) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest

DeleteClusterRequest returns a request value for making API operation for Managed Streaming for Kafka.

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. 

// Example sending a request using DeleteClusterRequest.
req := client.DeleteClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DeleteCluster

func (*Client) DescribeClusterOperationRequest added in v0.10.0 

func (c *Client) DescribeClusterOperationRequest(input *DescribeClusterOperationInput) DescribeClusterOperationRequest

DescribeClusterOperationRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a description of the cluster operation specified by the ARN. 

// Example sending a request using DescribeClusterOperationRequest.
req := client.DescribeClusterOperationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeClusterOperation

func (*Client) DescribeClusterRequest added in v0.9.0 

func (c *Client) DescribeClusterRequest(input *DescribeClusterInput) DescribeClusterRequest

DescribeClusterRequest returns a request value for making API operation for Managed Streaming for Kafka.

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

// Example sending a request using DescribeClusterRequest.
req := client.DescribeClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeCluster

func (*Client) DescribeConfigurationRequest added in v0.9.0 

func (c *Client) DescribeConfigurationRequest(input *DescribeConfigurationInput) DescribeConfigurationRequest

DescribeConfigurationRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a description of this MSK configuration. 

// Example sending a request using DescribeConfigurationRequest.
req := client.DescribeConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeConfiguration

func (*Client) DescribeConfigurationRevisionRequest added in v0.9.0 

func (c *Client) DescribeConfigurationRevisionRequest(input *DescribeConfigurationRevisionInput) DescribeConfigurationRevisionRequest

DescribeConfigurationRevisionRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a description of this revision of the configuration. 

// Example sending a request using DescribeConfigurationRevisionRequest.
req := client.DescribeConfigurationRevisionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeConfigurationRevision

func (*Client) GetBootstrapBrokersRequest added in v0.9.0 

func (c *Client) GetBootstrapBrokersRequest(input *GetBootstrapBrokersInput) GetBootstrapBrokersRequest

GetBootstrapBrokersRequest returns a request value for making API operation for Managed Streaming for Kafka.

A list of brokers that a client application can use to bootstrap. 

// Example sending a request using GetBootstrapBrokersRequest.
req := client.GetBootstrapBrokersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetBootstrapBrokers

func (*Client) ListClusterOperationsRequest added in v0.10.0 

func (c *Client) ListClusterOperationsRequest(input *ListClusterOperationsInput) ListClusterOperationsRequest

ListClusterOperationsRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of all the operations that have been performed on the specified MSK cluster. 

// Example sending a request using ListClusterOperationsRequest.
req := client.ListClusterOperationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListClusterOperations

func (*Client) ListClustersRequest added in v0.9.0 

func (c *Client) ListClustersRequest(input *ListClustersInput) ListClustersRequest

ListClustersRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of all the MSK clusters in the current Region. 

// Example sending a request using ListClustersRequest.
req := client.ListClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListClusters

func (*Client) ListConfigurationRevisionsRequest added in v0.10.0 

func (c *Client) ListConfigurationRevisionsRequest(input *ListConfigurationRevisionsInput) ListConfigurationRevisionsRequest

ListConfigurationRevisionsRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of all the revisions of an MSK configuration. 

// Example sending a request using ListConfigurationRevisionsRequest.
req := client.ListConfigurationRevisionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListConfigurationRevisions

func (*Client) ListConfigurationsRequest added in v0.9.0 

func (c *Client) ListConfigurationsRequest(input *ListConfigurationsInput) ListConfigurationsRequest

ListConfigurationsRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of all the MSK configurations in this Region. 

// Example sending a request using ListConfigurationsRequest.
req := client.ListConfigurationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListConfigurations

func (*Client) ListKafkaVersionsRequest added in v0.20.0 

func (c *Client) ListKafkaVersionsRequest(input *ListKafkaVersionsInput) ListKafkaVersionsRequest

ListKafkaVersionsRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of Kafka versions. 

// Example sending a request using ListKafkaVersionsRequest.
req := client.ListKafkaVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListKafkaVersions

func (*Client) ListNodesRequest added in v0.9.0 

func (c *Client) ListNodesRequest(input *ListNodesInput) ListNodesRequest

ListNodesRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of the broker nodes in the cluster. 

// Example sending a request using ListNodesRequest.
req := client.ListNodesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListNodes

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Managed Streaming for Kafka.

Returns a list of the tags associated with the specified resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListTagsForResource

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Managed Streaming for Kafka.

Adds tags to the specified MSK resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Managed Streaming for Kafka.

Removes the tags associated with the keys that are provided in the query. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UntagResource

func (*Client) UpdateBrokerCountRequest added in v0.15.0 

func (c *Client) UpdateBrokerCountRequest(input *UpdateBrokerCountInput) UpdateBrokerCountRequest

UpdateBrokerCountRequest returns a request value for making API operation for Managed Streaming for Kafka.

Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers. 

// Example sending a request using UpdateBrokerCountRequest.
req := client.UpdateBrokerCountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateBrokerCount

func (*Client) UpdateBrokerStorageRequest added in v0.10.0 

func (c *Client) UpdateBrokerStorageRequest(input *UpdateBrokerStorageInput) UpdateBrokerStorageRequest

UpdateBrokerStorageRequest returns a request value for making API operation for Managed Streaming for Kafka.

Updates the EBS storage associated with MSK brokers. 

// Example sending a request using UpdateBrokerStorageRequest.
req := client.UpdateBrokerStorageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateBrokerStorage

func (*Client) UpdateClusterConfigurationRequest added in v0.10.0 

func (c *Client) UpdateClusterConfigurationRequest(input *UpdateClusterConfigurationInput) UpdateClusterConfigurationRequest

UpdateClusterConfigurationRequest returns a request value for making API operation for Managed Streaming for Kafka.

Updates the cluster with the configuration that is specified in the request body. 

// Example sending a request using UpdateClusterConfigurationRequest.
req := client.UpdateClusterConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateClusterConfiguration

func (*Client) UpdateMonitoringRequest added in v0.18.0 

func (c *Client) UpdateMonitoringRequest(input *UpdateMonitoringInput) UpdateMonitoringRequest

UpdateMonitoringRequest returns a request value for making API operation for Managed Streaming for Kafka.

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. 

// Example sending a request using UpdateMonitoringRequest.
req := client.UpdateMonitoringRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateMonitoring

type CloudWatchLogs added in v0.20.0 

type CloudWatchLogs struct {

	// Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The CloudWatch log group that is the destination for broker logs.
	LogGroup *string `locationName:"logGroup" type:"string"`
	// contains filtered or unexported fields
}

Details of the CloudWatch Logs destination for broker logs.

func (CloudWatchLogs) MarshalFields added in v0.20.0 

func (s CloudWatchLogs) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CloudWatchLogs) String added in v0.20.0 

func (s CloudWatchLogs) String() string

String returns the string representation

func (*CloudWatchLogs) Validate added in v0.20.0 

func (s *CloudWatchLogs) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClusterInfo 

type ClusterInfo struct {

	// Arn of active cluster operation.
	ActiveOperationArn *string `locationName:"activeOperationArn" type:"string"`

	// Information about the broker nodes.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" type:"structure"`

	// Includes all client authentication information.
	ClientAuthentication *Authentication `locationName:"clientAuthentication" type:"structure"`

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The name of the cluster.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The time when the cluster was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"`

	// Information about the version of software currently deployed on the Kafka
	// brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo `locationName:"currentBrokerSoftwareInfo" type:"structure"`

	// The current version of the MSK cluster. Cluster versions aren't simple integers.
	// You can obtain the current version by describing the cluster. An example
	// version is KTVPDKIKX0DER.
	CurrentVersion *string `locationName:"currentVersion" type:"string"`

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo `locationName:"encryptionInfo" type:"structure"`

	// Specifies which metrics are gathered for the MSK cluster. This property has
	// three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For
	// a list of the metrics associated with each of these three levels of monitoring,
	// see Monitoring (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html).
	EnhancedMonitoring EnhancedMonitoring `locationName:"enhancedMonitoring" type:"string" enum:"true"`

	// You can configure your MSK cluster to send broker logs to different destination
	// types. This is a container for the configuration details related to broker
	// logs.
	LoggingInfo *LoggingInfo `locationName:"loggingInfo" type:"structure"`

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" type:"integer"`

	// Settings for open monitoring using Prometheus.
	OpenMonitoring *OpenMonitoring `locationName:"openMonitoring" type:"structure"`

	// The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
	State ClusterState `locationName:"state" type:"string" enum:"true"`

	// Tags attached to the cluster.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The connection string to use to connect to the Apache ZooKeeper cluster.
	ZookeeperConnectString *string `locationName:"zookeeperConnectString" type:"string"`
	// contains filtered or unexported fields
}

Returns information about a cluster.

func (ClusterInfo) MarshalFields 

func (s ClusterInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ClusterInfo) String 

func (s ClusterInfo) String() string

String returns the string representation

type ClusterOperationInfo added in v0.10.0 

type ClusterOperationInfo struct {

	// The ID of the API request that triggered this operation.
	ClientRequestId *string `locationName:"clientRequestId" type:"string"`

	// ARN of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The time at which operation was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"`

	// The time at which the operation finished.
	EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

	// Describes the error if the operation fails.
	ErrorInfo *ErrorInfo `locationName:"errorInfo" type:"structure"`

	// ARN of the cluster operation.
	OperationArn *string `locationName:"operationArn" type:"string"`

	// State of the cluster operation.
	OperationState *string `locationName:"operationState" type:"string"`

	// Type of the cluster operation.
	OperationType *string `locationName:"operationType" type:"string"`

	// Information about cluster attributes before a cluster is updated.
	SourceClusterInfo *MutableClusterInfo `locationName:"sourceClusterInfo" type:"structure"`

	// Information about cluster attributes after a cluster is updated.
	TargetClusterInfo *MutableClusterInfo `locationName:"targetClusterInfo" type:"structure"`
	// contains filtered or unexported fields
}

Returns information about a cluster operation.

func (ClusterOperationInfo) MarshalFields added in v0.10.0 

func (s ClusterOperationInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ClusterOperationInfo) String added in v0.10.0 

func (s ClusterOperationInfo) String() string

String returns the string representation

type ClusterState 

type ClusterState string

The state of a Kafka cluster. 

const (
	ClusterStateActive   ClusterState = "ACTIVE"
	ClusterStateCreating ClusterState = "CREATING"
	ClusterStateUpdating ClusterState = "UPDATING"
	ClusterStateDeleting ClusterState = "DELETING"
	ClusterStateFailed   ClusterState = "FAILED"
)

Enum values for ClusterState

func (ClusterState) MarshalValue 

func (enum ClusterState) MarshalValue() (string, error)

func (ClusterState) MarshalValueBuf 

func (enum ClusterState) MarshalValueBuf(b []byte) ([]byte, error)

type Configuration added in v0.9.0 

type Configuration struct {

	// The Amazon Resource Name (ARN) of the configuration.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// CreationTime is a required field
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the configuration.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// An array of the versions of Apache Kafka with which you can use this MSK
	// configuration. You can use this configuration for an MSK cluster only if
	// the Apache Kafka version specified for the cluster appears in this array.
	//
	// KafkaVersions is a required field
	KafkaVersions []string `locationName:"kafkaVersions" type:"list" required:"true"`

	// Latest revision of the configuration.
	//
	// LatestRevision is a required field
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure" required:"true"`

	// The name of the configuration. Configuration names are strings that match
	// the regex "^[0-9A-Za-z-]+$".
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an MSK Configuration.

func (Configuration) MarshalFields added in v0.9.0 

func (s Configuration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Configuration) String added in v0.9.0 

func (s Configuration) String() string

String returns the string representation

type ConfigurationInfo added in v0.9.0 

type ConfigurationInfo struct {

	// ARN of the configuration to use.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The revision of the configuration to use.
	//
	// Revision is a required field
	Revision *int64 `locationName:"revision" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Specifies the configuration to use for the brokers.

func (ConfigurationInfo) MarshalFields added in v0.9.0 

func (s ConfigurationInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigurationInfo) String added in v0.9.0 

func (s ConfigurationInfo) String() string

String returns the string representation

func (*ConfigurationInfo) Validate added in v0.9.0 

func (s *ConfigurationInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfigurationRevision added in v0.9.0 

type ConfigurationRevision struct {

	// The time when the configuration revision was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the configuration revision.
	Description *string `locationName:"description" type:"string"`

	// The revision number.
	//
	// Revision is a required field
	Revision *int64 `locationName:"revision" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Describes a configuration revision.

func (ConfigurationRevision) MarshalFields added in v0.9.0 

func (s ConfigurationRevision) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigurationRevision) String added in v0.9.0 

func (s ConfigurationRevision) String() string

String returns the string representation

type CreateClusterInput 

type CreateClusterInput struct {

	// Information about the broker nodes in the cluster.
	//
	// BrokerNodeGroupInfo is a required field
	BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" type:"structure" required:"true"`

	// Includes all client authentication related information.
	ClientAuthentication *Authentication `locationName:"clientAuthentication" type:"structure"`

	// The name of the cluster.
	//
	// ClusterName is a required field
	ClusterName *string `locationName:"clusterName" min:"1" type:"string" required:"true"`

	// Represents the configuration that you want MSK to use for the cluster.
	ConfigurationInfo *ConfigurationInfo `locationName:"configurationInfo" type:"structure"`

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo `locationName:"encryptionInfo" type:"structure"`

	// Specifies the level of monitoring for the MSK cluster. The possible values
	// are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.
	EnhancedMonitoring EnhancedMonitoring `locationName:"enhancedMonitoring" type:"string" enum:"true"`

	// The version of Apache Kafka.
	//
	// KafkaVersion is a required field
	KafkaVersion *string `locationName:"kafkaVersion" min:"1" type:"string" required:"true"`

	// LoggingInfo details.
	LoggingInfo *LoggingInfo `locationName:"loggingInfo" type:"structure"`

	// The number of Kafka broker nodes in the Amazon MSK cluster.
	//
	// NumberOfBrokerNodes is a required field
	NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" min:"1" type:"integer" required:"true"`

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo `locationName:"openMonitoring" type:"structure"`

	// Create tags when creating the cluster.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Creates a cluster.

func (CreateClusterInput) MarshalFields 

func (s CreateClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateClusterInput) String 

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate 

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterOutput 

type CreateClusterOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The name of the MSK cluster.
	ClusterName *string `locationName:"clusterName" type:"string"`

	// The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
	State ClusterState `locationName:"state" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Returns information about the created cluster.

func (CreateClusterOutput) MarshalFields 

func (s CreateClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateClusterOutput) String 

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateClusterRequest 

type CreateClusterRequest struct {
	*aws.Request
	Input *CreateClusterInput
	Copy  func(*CreateClusterInput) CreateClusterRequest
}

CreateClusterRequest is the request type for the CreateCluster API operation.

func (CreateClusterRequest) Send 

func (r CreateClusterRequest) Send(ctx context.Context) (*CreateClusterResponse, error)

Send marshals and sends the CreateCluster API request.

type CreateClusterResponse added in v0.9.0 

type CreateClusterResponse struct {
	*CreateClusterOutput
	// contains filtered or unexported fields
}

CreateClusterResponse is the response type for the CreateCluster API operation.

func (*CreateClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCluster request.

type CreateConfigurationInput added in v0.9.0 

type CreateConfigurationInput struct {

	// The description of the configuration.
	Description *string `locationName:"description" type:"string"`

	// The versions of Apache Kafka with which you can use this MSK configuration.
	//
	// KafkaVersions is a required field
	KafkaVersions []string `locationName:"kafkaVersions" type:"list" required:"true"`

	// The name of the configuration. Configuration names are strings that match
	// the regex "^[0-9A-Za-z-]+$".
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// ServerProperties is automatically base64 encoded/decoded by the SDK.
	//
	// ServerProperties is a required field
	ServerProperties []byte `locationName:"serverProperties" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Request body for CreateConfiguration.

func (CreateConfigurationInput) MarshalFields added in v0.9.0 

func (s CreateConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationInput) String added in v0.9.0 

func (s CreateConfigurationInput) String() string

String returns the string representation

func (*CreateConfigurationInput) Validate added in v0.9.0 

func (s *CreateConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConfigurationOutput added in v0.9.0 

type CreateConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	Arn *string `locationName:"arn" type:"string"`

	// The time when the configuration was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"`

	// Latest revision of the configuration.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	// The name of the configuration. Configuration names are strings that match
	// the regex "^[0-9A-Za-z-]+$".
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Response body for CreateConfiguration

func (CreateConfigurationOutput) MarshalFields added in v0.9.0 

func (s CreateConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationOutput) String added in v0.9.0 

func (s CreateConfigurationOutput) String() string

String returns the string representation

type CreateConfigurationRequest added in v0.9.0 

type CreateConfigurationRequest struct {
	*aws.Request
	Input *CreateConfigurationInput
	Copy  func(*CreateConfigurationInput) CreateConfigurationRequest
}

CreateConfigurationRequest is the request type for the CreateConfiguration API operation.

func (CreateConfigurationRequest) Send added in v0.9.0 

func (r CreateConfigurationRequest) Send(ctx context.Context) (*CreateConfigurationResponse, error)

Send marshals and sends the CreateConfiguration API request.

type CreateConfigurationResponse added in v0.9.0 

type CreateConfigurationResponse struct {
	*CreateConfigurationOutput
	// contains filtered or unexported fields
}

CreateConfigurationResponse is the response type for the CreateConfiguration API operation.

func (*CreateConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateConfiguration request.

type DeleteClusterInput 

type DeleteClusterInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	CurrentVersion *string `location:"querystring" locationName:"currentVersion" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) MarshalFields 

func (s DeleteClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteClusterInput) String 

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate 

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
	State ClusterState `locationName:"state" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Returns information about the deleted cluster.

func (DeleteClusterOutput) MarshalFields 

func (s DeleteClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteClusterOutput) String 

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteClusterRequest 

type DeleteClusterRequest struct {
	*aws.Request
	Input *DeleteClusterInput
	Copy  func(*DeleteClusterInput) DeleteClusterRequest
}

DeleteClusterRequest is the request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send 

func (r DeleteClusterRequest) Send(ctx context.Context) (*DeleteClusterResponse, error)

Send marshals and sends the DeleteCluster API request.

type DeleteClusterResponse added in v0.9.0 

type DeleteClusterResponse struct {
	*DeleteClusterOutput
	// contains filtered or unexported fields
}

DeleteClusterResponse is the response type for the DeleteCluster API operation.

func (*DeleteClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCluster request.

type DescribeClusterInput 

type DescribeClusterInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeClusterInput) MarshalFields 

func (s DescribeClusterInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterInput) String 

func (s DescribeClusterInput) String() string

String returns the string representation

func (*DescribeClusterInput) Validate 

func (s *DescribeClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeClusterOperationInput added in v0.10.0 

type DescribeClusterOperationInput struct {

	// ClusterOperationArn is a required field
	ClusterOperationArn *string `location:"uri" locationName:"clusterOperationArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeClusterOperationInput) MarshalFields added in v0.10.0 

func (s DescribeClusterOperationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterOperationInput) String added in v0.10.0 

func (s DescribeClusterOperationInput) String() string

String returns the string representation

func (*DescribeClusterOperationInput) Validate added in v0.10.0 

func (s *DescribeClusterOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeClusterOperationOutput added in v0.10.0 

type DescribeClusterOperationOutput struct {

	// Cluster operation information
	ClusterOperationInfo *ClusterOperationInfo `locationName:"clusterOperationInfo" type:"structure"`
	// contains filtered or unexported fields
}

Information about a cluster operation.

func (DescribeClusterOperationOutput) MarshalFields added in v0.10.0 

func (s DescribeClusterOperationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterOperationOutput) String added in v0.10.0 

func (s DescribeClusterOperationOutput) String() string

String returns the string representation

type DescribeClusterOperationRequest added in v0.10.0 

type DescribeClusterOperationRequest struct {
	*aws.Request
	Input *DescribeClusterOperationInput
	Copy  func(*DescribeClusterOperationInput) DescribeClusterOperationRequest
}

DescribeClusterOperationRequest is the request type for the DescribeClusterOperation API operation.

func (DescribeClusterOperationRequest) Send added in v0.10.0 

func (r DescribeClusterOperationRequest) Send(ctx context.Context) (*DescribeClusterOperationResponse, error)

Send marshals and sends the DescribeClusterOperation API request.

type DescribeClusterOperationResponse added in v0.10.0 

type DescribeClusterOperationResponse struct {
	*DescribeClusterOperationOutput
	// contains filtered or unexported fields
}

DescribeClusterOperationResponse is the response type for the DescribeClusterOperation API operation.

func (*DescribeClusterOperationResponse) SDKResponseMetdata added in v0.10.0 

func (r *DescribeClusterOperationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeClusterOperation request.

type DescribeClusterOutput 

type DescribeClusterOutput struct {

	// The cluster information.
	ClusterInfo *ClusterInfo `locationName:"clusterInfo" type:"structure"`
	// contains filtered or unexported fields
}

Returns information about a cluster.

func (DescribeClusterOutput) MarshalFields 

func (s DescribeClusterOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeClusterOutput) String 

func (s DescribeClusterOutput) String() string

String returns the string representation

type DescribeClusterRequest 

type DescribeClusterRequest struct {
	*aws.Request
	Input *DescribeClusterInput
	Copy  func(*DescribeClusterInput) DescribeClusterRequest
}

DescribeClusterRequest is the request type for the DescribeCluster API operation.

func (DescribeClusterRequest) Send 

func (r DescribeClusterRequest) Send(ctx context.Context) (*DescribeClusterResponse, error)

Send marshals and sends the DescribeCluster API request.

type DescribeClusterResponse added in v0.9.0 

type DescribeClusterResponse struct {
	*DescribeClusterOutput
	// contains filtered or unexported fields
}

DescribeClusterResponse is the response type for the DescribeCluster API operation.

func (*DescribeClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCluster request.

type DescribeConfigurationInput added in v0.9.0 

type DescribeConfigurationInput struct {

	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationInput) MarshalFields added in v0.9.0 

func (s DescribeConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationInput) String added in v0.9.0 

func (s DescribeConfigurationInput) String() string

String returns the string representation

func (*DescribeConfigurationInput) Validate added in v0.9.0 

func (s *DescribeConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeConfigurationOutput added in v0.9.0 

type DescribeConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	Arn *string `locationName:"arn" type:"string"`

	// The time when the configuration was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"`

	// The description of the configuration.
	Description *string `locationName:"description" type:"string"`

	// The versions of Apache Kafka with which you can use this MSK configuration.
	KafkaVersions []string `locationName:"kafkaVersions" type:"list"`

	// Latest revision of the configuration.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	// The name of the configuration. Configuration names are strings that match
	// the regex "^[0-9A-Za-z-]+$".
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Response body for DescribeConfiguration.

func (DescribeConfigurationOutput) MarshalFields added in v0.9.0 

func (s DescribeConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationOutput) String added in v0.9.0 

func (s DescribeConfigurationOutput) String() string

String returns the string representation

type DescribeConfigurationRequest added in v0.9.0 

type DescribeConfigurationRequest struct {
	*aws.Request
	Input *DescribeConfigurationInput
	Copy  func(*DescribeConfigurationInput) DescribeConfigurationRequest
}

DescribeConfigurationRequest is the request type for the DescribeConfiguration API operation.

func (DescribeConfigurationRequest) Send added in v0.9.0 

func (r DescribeConfigurationRequest) Send(ctx context.Context) (*DescribeConfigurationResponse, error)

Send marshals and sends the DescribeConfiguration API request.

type DescribeConfigurationResponse added in v0.9.0 

type DescribeConfigurationResponse struct {
	*DescribeConfigurationOutput
	// contains filtered or unexported fields
}

DescribeConfigurationResponse is the response type for the DescribeConfiguration API operation.

func (*DescribeConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeConfiguration request.

type DescribeConfigurationRevisionInput added in v0.9.0 

type DescribeConfigurationRevisionInput struct {

	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`

	// Revision is a required field
	Revision *int64 `location:"uri" locationName:"revision" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationRevisionInput) MarshalFields added in v0.9.0 

func (s DescribeConfigurationRevisionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationRevisionInput) String added in v0.9.0 

func (s DescribeConfigurationRevisionInput) String() string

String returns the string representation

func (*DescribeConfigurationRevisionInput) Validate added in v0.9.0 

func (s *DescribeConfigurationRevisionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeConfigurationRevisionOutput added in v0.9.0 

type DescribeConfigurationRevisionOutput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	Arn *string `locationName:"arn" type:"string"`

	// The time when the configuration was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"`

	// The description of the configuration.
	Description *string `locationName:"description" type:"string"`

	// The revision number.
	Revision *int64 `locationName:"revision" type:"long"`

	// ServerProperties is automatically base64 encoded/decoded by the SDK.
	ServerProperties []byte `locationName:"serverProperties" type:"blob"`
	// contains filtered or unexported fields
}

Response body for DescribeConfigurationRevision.

func (DescribeConfigurationRevisionOutput) MarshalFields added in v0.9.0 

func (s DescribeConfigurationRevisionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationRevisionOutput) String added in v0.9.0 

func (s DescribeConfigurationRevisionOutput) String() string

String returns the string representation

type DescribeConfigurationRevisionRequest added in v0.9.0 

type DescribeConfigurationRevisionRequest struct {
	*aws.Request
	Input *DescribeConfigurationRevisionInput
	Copy  func(*DescribeConfigurationRevisionInput) DescribeConfigurationRevisionRequest
}

DescribeConfigurationRevisionRequest is the request type for the DescribeConfigurationRevision API operation.

func (DescribeConfigurationRevisionRequest) Send added in v0.9.0 

func (r DescribeConfigurationRevisionRequest) Send(ctx context.Context) (*DescribeConfigurationRevisionResponse, error)

Send marshals and sends the DescribeConfigurationRevision API request.

type DescribeConfigurationRevisionResponse added in v0.9.0 

type DescribeConfigurationRevisionResponse struct {
	*DescribeConfigurationRevisionOutput
	// contains filtered or unexported fields
}

DescribeConfigurationRevisionResponse is the response type for the DescribeConfigurationRevision API operation.

func (*DescribeConfigurationRevisionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeConfigurationRevisionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeConfigurationRevision request.

type EBSStorageInfo 

type EBSStorageInfo struct {

	// The size in GiB of the EBS volume for the data drive on each broker node.
	VolumeSize *int64 `locationName:"volumeSize" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Contains information about the EBS storage volumes attached to Kafka broker nodes.

func (EBSStorageInfo) MarshalFields 

func (s EBSStorageInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EBSStorageInfo) String 

func (s EBSStorageInfo) String() string

String returns the string representation

func (*EBSStorageInfo) Validate 

func (s *EBSStorageInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptionAtRest 

type EncryptionAtRest struct {

	// The ARN of the AWS KMS key for encrypting data at rest. If you don't specify
	// a KMS key, MSK creates one for you and uses it.
	//
	// DataVolumeKMSKeyId is a required field
	DataVolumeKMSKeyId *string `locationName:"dataVolumeKMSKeyId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The data-volume encryption details.

func (EncryptionAtRest) MarshalFields 

func (s EncryptionAtRest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionAtRest) String 

func (s EncryptionAtRest) String() string

String returns the string representation

func (*EncryptionAtRest) Validate 

func (s *EncryptionAtRest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptionInTransit added in v0.10.0 

type EncryptionInTransit struct {

	// Indicates the encryption setting for data in transit between clients and
	// brokers. You must set it to one of the following values.
	//
	// TLS means that client-broker communication is enabled with TLS only.
	//
	// TLS_PLAINTEXT means that client-broker communication is enabled for both
	// TLS-encrypted, as well as plaintext data.
	//
	// PLAINTEXT means that client-broker communication is enabled in plaintext
	// only.
	//
	// The default value is TLS.
	ClientBroker Broker `locationName:"clientBroker" type:"string" enum:"true"`

	// When set to true, it indicates that data communication among the broker nodes
	// of the cluster is encrypted. When set to false, the communication happens
	// in plaintext.
	//
	// The default value is true.
	InCluster *bool `locationName:"inCluster" type:"boolean"`
	// contains filtered or unexported fields
}

The settings for encrypting data in transit.

func (EncryptionInTransit) MarshalFields added in v0.10.0 

func (s EncryptionInTransit) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionInTransit) String added in v0.10.0 

func (s EncryptionInTransit) String() string

String returns the string representation

type EncryptionInfo 

type EncryptionInfo struct {

	// The data-volume encryption details.
	EncryptionAtRest *EncryptionAtRest `locationName:"encryptionAtRest" type:"structure"`

	// The details for encryption in transit.
	EncryptionInTransit *EncryptionInTransit `locationName:"encryptionInTransit" type:"structure"`
	// contains filtered or unexported fields
}

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

func (EncryptionInfo) MarshalFields 

func (s EncryptionInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionInfo) String 

func (s EncryptionInfo) String() string

String returns the string representation

func (*EncryptionInfo) Validate 

func (s *EncryptionInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnhancedMonitoring 

type EnhancedMonitoring string

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html). 

const (
	EnhancedMonitoringDefault           EnhancedMonitoring = "DEFAULT"
	EnhancedMonitoringPerBroker         EnhancedMonitoring = "PER_BROKER"
	EnhancedMonitoringPerTopicPerBroker EnhancedMonitoring = "PER_TOPIC_PER_BROKER"
)

Enum values for EnhancedMonitoring

func (EnhancedMonitoring) MarshalValue 

func (enum EnhancedMonitoring) MarshalValue() (string, error)

func (EnhancedMonitoring) MarshalValueBuf 

func (enum EnhancedMonitoring) MarshalValueBuf(b []byte) ([]byte, error)

type ErrorInfo added in v0.10.0 

type ErrorInfo struct {

	// A number describing the error programmatically.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// An optional field to provide more details about the error.
	ErrorString *string `locationName:"errorString" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error state of the cluster.

func (ErrorInfo) MarshalFields added in v0.10.0 

func (s ErrorInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorInfo) String added in v0.10.0 

func (s ErrorInfo) String() string

String returns the string representation

type Firehose added in v0.20.0 

type Firehose struct {

	// The Kinesis Data Firehose delivery stream that is the destination for broker
	// logs.
	DeliveryStream *string `locationName:"deliveryStream" type:"string"`

	// Specifies whether broker logs get sent to the specified Kinesis Data Firehose
	// delivery stream.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Firehose details for BrokerLogs.

func (Firehose) MarshalFields added in v0.20.0 

func (s Firehose) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Firehose) String added in v0.20.0 

func (s Firehose) String() string

String returns the string representation

func (*Firehose) Validate added in v0.20.0 

func (s *Firehose) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBootstrapBrokersInput 

type GetBootstrapBrokersInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBootstrapBrokersInput) MarshalFields 

func (s GetBootstrapBrokersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBootstrapBrokersInput) String 

func (s GetBootstrapBrokersInput) String() string

String returns the string representation

func (*GetBootstrapBrokersInput) Validate 

func (s *GetBootstrapBrokersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBootstrapBrokersOutput 

type GetBootstrapBrokersOutput struct {

	// A string containing one or more hostname:port pairs.
	BootstrapBrokerString *string `locationName:"bootstrapBrokerString" type:"string"`

	// A string containing one or more DNS names (or IP) and TLS port pairs. The
	// following is an example.
	//  { "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094"}
	BootstrapBrokerStringTls *string `locationName:"bootstrapBrokerStringTls" type:"string"`
	// contains filtered or unexported fields
}

Returns a string containing one or more hostname:port pairs.

func (GetBootstrapBrokersOutput) MarshalFields 

func (s GetBootstrapBrokersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetBootstrapBrokersOutput) String 

func (s GetBootstrapBrokersOutput) String() string

String returns the string representation

type GetBootstrapBrokersRequest 

type GetBootstrapBrokersRequest struct {
	*aws.Request
	Input *GetBootstrapBrokersInput
	Copy  func(*GetBootstrapBrokersInput) GetBootstrapBrokersRequest
}

GetBootstrapBrokersRequest is the request type for the GetBootstrapBrokers API operation.

func (GetBootstrapBrokersRequest) Send 

func (r GetBootstrapBrokersRequest) Send(ctx context.Context) (*GetBootstrapBrokersResponse, error)

Send marshals and sends the GetBootstrapBrokers API request.

type GetBootstrapBrokersResponse added in v0.9.0 

type GetBootstrapBrokersResponse struct {
	*GetBootstrapBrokersOutput
	// contains filtered or unexported fields
}

GetBootstrapBrokersResponse is the response type for the GetBootstrapBrokers API operation.

func (*GetBootstrapBrokersResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetBootstrapBrokersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetBootstrapBrokers request.

type JmxExporter added in v0.18.0 

type JmxExporter struct {

	// Indicates whether you want to enable or disable the JMX Exporter.
	//
	// EnabledInBroker is a required field
	EnabledInBroker *bool `locationName:"enabledInBroker" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Indicates whether you want to enable or disable the JMX Exporter.

func (JmxExporter) MarshalFields added in v0.18.0 

func (s JmxExporter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JmxExporter) String added in v0.18.0 

func (s JmxExporter) String() string

String returns the string representation

type JmxExporterInfo added in v0.18.0 

type JmxExporterInfo struct {

	// JMX Exporter being enabled in broker.
	//
	// EnabledInBroker is a required field
	EnabledInBroker *bool `locationName:"enabledInBroker" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Indicates whether you want to enable or disable the JMX Exporter.

func (JmxExporterInfo) MarshalFields added in v0.18.0 

func (s JmxExporterInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (JmxExporterInfo) String added in v0.18.0 

func (s JmxExporterInfo) String() string

String returns the string representation

func (*JmxExporterInfo) Validate added in v0.18.0 

func (s *JmxExporterInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KafkaVersion added in v0.20.0 

type KafkaVersion struct {

	// The status of the Apache Kafka version.
	Status KafkaVersionStatus `locationName:"status" type:"string" enum:"true"`

	// The Kafka version.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

Information about a Kafka version.

func (KafkaVersion) MarshalFields added in v0.20.0 

func (s KafkaVersion) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (KafkaVersion) String added in v0.20.0 

func (s KafkaVersion) String() string

String returns the string representation

type KafkaVersionStatus added in v0.20.0 

type KafkaVersionStatus string

The status of a Kafka version. 

const (
	KafkaVersionStatusActive     KafkaVersionStatus = "ACTIVE"
	KafkaVersionStatusDeprecated KafkaVersionStatus = "DEPRECATED"
)

Enum values for KafkaVersionStatus

func (KafkaVersionStatus) MarshalValue added in v0.20.0 

func (enum KafkaVersionStatus) MarshalValue() (string, error)

func (KafkaVersionStatus) MarshalValueBuf added in v0.20.0 

func (enum KafkaVersionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ListClusterOperationsInput added in v0.10.0 

type ListClusterOperationsInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClusterOperationsInput) MarshalFields added in v0.10.0 

func (s ListClusterOperationsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClusterOperationsInput) String added in v0.10.0 

func (s ListClusterOperationsInput) String() string

String returns the string representation

func (*ListClusterOperationsInput) Validate added in v0.10.0 

func (s *ListClusterOperationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClusterOperationsOutput added in v0.10.0 

type ListClusterOperationsOutput struct {

	// An array of cluster operation information objects.
	ClusterOperationInfoList []ClusterOperationInfo `locationName:"clusterOperationInfoList" type:"list"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response contains an array containing cluster operation information and a next token if the response is truncated.

func (ListClusterOperationsOutput) MarshalFields added in v0.10.0 

func (s ListClusterOperationsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClusterOperationsOutput) String added in v0.10.0 

func (s ListClusterOperationsOutput) String() string

String returns the string representation

type ListClusterOperationsPaginator added in v0.10.0 

type ListClusterOperationsPaginator struct {
	aws.Pager
}

ListClusterOperationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListClusterOperationsPaginator added in v0.10.0 

func NewListClusterOperationsPaginator(req ListClusterOperationsRequest) ListClusterOperationsPaginator

NewListClusterOperationsRequestPaginator returns a paginator for ListClusterOperations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListClusterOperationsRequest(input)
p := kafka.NewListClusterOperationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListClusterOperationsPaginator) CurrentPage added in v0.10.0 

func (p *ListClusterOperationsPaginator) CurrentPage() *ListClusterOperationsOutput

type ListClusterOperationsRequest added in v0.10.0 

type ListClusterOperationsRequest struct {
	*aws.Request
	Input *ListClusterOperationsInput
	Copy  func(*ListClusterOperationsInput) ListClusterOperationsRequest
}

ListClusterOperationsRequest is the request type for the ListClusterOperations API operation.

func (ListClusterOperationsRequest) Send added in v0.10.0 

func (r ListClusterOperationsRequest) Send(ctx context.Context) (*ListClusterOperationsResponse, error)

Send marshals and sends the ListClusterOperations API request.

type ListClusterOperationsResponse added in v0.10.0 

type ListClusterOperationsResponse struct {
	*ListClusterOperationsOutput
	// contains filtered or unexported fields
}

ListClusterOperationsResponse is the response type for the ListClusterOperations API operation.

func (*ListClusterOperationsResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListClusterOperationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListClusterOperations request.

type ListClustersInput 

type ListClustersInput struct {
	ClusterNameFilter *string `location:"querystring" locationName:"clusterNameFilter" type:"string"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersInput) MarshalFields 

func (s ListClustersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClustersInput) String 

func (s ListClustersInput) String() string

String returns the string representation

func (*ListClustersInput) Validate 

func (s *ListClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClustersOutput 

type ListClustersOutput struct {

	// Information on each of the MSK clusters in the response.
	ClusterInfoList []ClusterInfo `locationName:"clusterInfoList" type:"list"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response contains an array containing cluster information and a next token if the response is truncated.

func (ListClustersOutput) MarshalFields 

func (s ListClustersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListClustersOutput) String 

func (s ListClustersOutput) String() string

String returns the string representation

type ListClustersPaginator added in v0.9.0 

type ListClustersPaginator struct {
	aws.Pager
}

ListClustersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListClustersPaginator added in v0.9.0 

func NewListClustersPaginator(req ListClustersRequest) ListClustersPaginator

NewListClustersRequestPaginator returns a paginator for ListClusters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListClustersRequest(input)
p := kafka.NewListClustersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListClustersPaginator) CurrentPage added in v0.9.0 

func (p *ListClustersPaginator) CurrentPage() *ListClustersOutput

type ListClustersRequest 

type ListClustersRequest struct {
	*aws.Request
	Input *ListClustersInput
	Copy  func(*ListClustersInput) ListClustersRequest
}

ListClustersRequest is the request type for the ListClusters API operation.

func (ListClustersRequest) Send 

func (r ListClustersRequest) Send(ctx context.Context) (*ListClustersResponse, error)

Send marshals and sends the ListClusters API request.

type ListClustersResponse added in v0.9.0 

type ListClustersResponse struct {
	*ListClustersOutput
	// contains filtered or unexported fields
}

ListClustersResponse is the response type for the ListClusters API operation.

func (*ListClustersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListClusters request.

type ListConfigurationRevisionsInput added in v0.10.0 

type ListConfigurationRevisionsInput struct {

	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationRevisionsInput) MarshalFields added in v0.10.0 

func (s ListConfigurationRevisionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationRevisionsInput) String added in v0.10.0 

func (s ListConfigurationRevisionsInput) String() string

String returns the string representation

func (*ListConfigurationRevisionsInput) Validate added in v0.10.0 

func (s *ListConfigurationRevisionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConfigurationRevisionsOutput added in v0.10.0 

type ListConfigurationRevisionsOutput struct {

	// Paginated results marker.
	NextToken *string `locationName:"nextToken" type:"string"`

	// List of ConfigurationRevision objects.
	Revisions []ConfigurationRevision `locationName:"revisions" type:"list"`
	// contains filtered or unexported fields
}

Information about revisions of an MSK configuration.

func (ListConfigurationRevisionsOutput) MarshalFields added in v0.10.0 

func (s ListConfigurationRevisionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationRevisionsOutput) String added in v0.10.0 

func (s ListConfigurationRevisionsOutput) String() string

String returns the string representation

type ListConfigurationRevisionsPaginator added in v0.10.0 

type ListConfigurationRevisionsPaginator struct {
	aws.Pager
}

ListConfigurationRevisionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListConfigurationRevisionsPaginator added in v0.10.0 

func NewListConfigurationRevisionsPaginator(req ListConfigurationRevisionsRequest) ListConfigurationRevisionsPaginator

NewListConfigurationRevisionsRequestPaginator returns a paginator for ListConfigurationRevisions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListConfigurationRevisionsRequest(input)
p := kafka.NewListConfigurationRevisionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListConfigurationRevisionsPaginator) CurrentPage added in v0.10.0 

func (p *ListConfigurationRevisionsPaginator) CurrentPage() *ListConfigurationRevisionsOutput

type ListConfigurationRevisionsRequest added in v0.10.0 

type ListConfigurationRevisionsRequest struct {
	*aws.Request
	Input *ListConfigurationRevisionsInput
	Copy  func(*ListConfigurationRevisionsInput) ListConfigurationRevisionsRequest
}

ListConfigurationRevisionsRequest is the request type for the ListConfigurationRevisions API operation.

func (ListConfigurationRevisionsRequest) Send added in v0.10.0 

func (r ListConfigurationRevisionsRequest) Send(ctx context.Context) (*ListConfigurationRevisionsResponse, error)

Send marshals and sends the ListConfigurationRevisions API request.

type ListConfigurationRevisionsResponse added in v0.10.0 

type ListConfigurationRevisionsResponse struct {
	*ListConfigurationRevisionsOutput
	// contains filtered or unexported fields
}

ListConfigurationRevisionsResponse is the response type for the ListConfigurationRevisions API operation.

func (*ListConfigurationRevisionsResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListConfigurationRevisionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListConfigurationRevisions request.

type ListConfigurationsInput added in v0.9.0 

type ListConfigurationsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListConfigurationsInput) MarshalFields added in v0.9.0 

func (s ListConfigurationsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationsInput) String added in v0.9.0 

func (s ListConfigurationsInput) String() string

String returns the string representation

func (*ListConfigurationsInput) Validate added in v0.10.0 

func (s *ListConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConfigurationsOutput added in v0.9.0 

type ListConfigurationsOutput struct {

	// An array of MSK configurations.
	Configurations []Configuration `locationName:"configurations" type:"list"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The response contains an array of Configuration and a next token if the response is truncated.

func (ListConfigurationsOutput) MarshalFields added in v0.9.0 

func (s ListConfigurationsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationsOutput) String added in v0.9.0 

func (s ListConfigurationsOutput) String() string

String returns the string representation

type ListConfigurationsPaginator added in v0.9.0 

type ListConfigurationsPaginator struct {
	aws.Pager
}

ListConfigurationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListConfigurationsPaginator added in v0.9.0 

func NewListConfigurationsPaginator(req ListConfigurationsRequest) ListConfigurationsPaginator

NewListConfigurationsRequestPaginator returns a paginator for ListConfigurations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListConfigurationsRequest(input)
p := kafka.NewListConfigurationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListConfigurationsPaginator) CurrentPage added in v0.9.0 

func (p *ListConfigurationsPaginator) CurrentPage() *ListConfigurationsOutput

type ListConfigurationsRequest added in v0.9.0 

type ListConfigurationsRequest struct {
	*aws.Request
	Input *ListConfigurationsInput
	Copy  func(*ListConfigurationsInput) ListConfigurationsRequest
}

ListConfigurationsRequest is the request type for the ListConfigurations API operation.

func (ListConfigurationsRequest) Send added in v0.9.0 

func (r ListConfigurationsRequest) Send(ctx context.Context) (*ListConfigurationsResponse, error)

Send marshals and sends the ListConfigurations API request.

type ListConfigurationsResponse added in v0.9.0 

type ListConfigurationsResponse struct {
	*ListConfigurationsOutput
	// contains filtered or unexported fields
}

ListConfigurationsResponse is the response type for the ListConfigurations API operation.

func (*ListConfigurationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListConfigurationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListConfigurations request.

type ListKafkaVersionsInput added in v0.20.0 

type ListKafkaVersionsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListKafkaVersionsInput) MarshalFields added in v0.20.0 

func (s ListKafkaVersionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListKafkaVersionsInput) String added in v0.20.0 

func (s ListKafkaVersionsInput) String() string

String returns the string representation

func (*ListKafkaVersionsInput) Validate added in v0.20.0 

func (s *ListKafkaVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKafkaVersionsOutput added in v0.20.0 

type ListKafkaVersionsOutput struct {

	// An array of Kafka version objects.
	KafkaVersions []KafkaVersion `locationName:"kafkaVersions" type:"list"`

	// Paginated results marker.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Response for ListKafkaVersions.

func (ListKafkaVersionsOutput) MarshalFields added in v0.20.0 

func (s ListKafkaVersionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListKafkaVersionsOutput) String added in v0.20.0 

func (s ListKafkaVersionsOutput) String() string

String returns the string representation

type ListKafkaVersionsPaginator added in v0.20.0 

type ListKafkaVersionsPaginator struct {
	aws.Pager
}

ListKafkaVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListKafkaVersionsPaginator added in v0.20.0 

func NewListKafkaVersionsPaginator(req ListKafkaVersionsRequest) ListKafkaVersionsPaginator

NewListKafkaVersionsRequestPaginator returns a paginator for ListKafkaVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListKafkaVersionsRequest(input)
p := kafka.NewListKafkaVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListKafkaVersionsPaginator) CurrentPage added in v0.20.0 

func (p *ListKafkaVersionsPaginator) CurrentPage() *ListKafkaVersionsOutput

type ListKafkaVersionsRequest added in v0.20.0 

type ListKafkaVersionsRequest struct {
	*aws.Request
	Input *ListKafkaVersionsInput
	Copy  func(*ListKafkaVersionsInput) ListKafkaVersionsRequest
}

ListKafkaVersionsRequest is the request type for the ListKafkaVersions API operation.

func (ListKafkaVersionsRequest) Send added in v0.20.0 

func (r ListKafkaVersionsRequest) Send(ctx context.Context) (*ListKafkaVersionsResponse, error)

Send marshals and sends the ListKafkaVersions API request.

type ListKafkaVersionsResponse added in v0.20.0 

type ListKafkaVersionsResponse struct {
	*ListKafkaVersionsOutput
	// contains filtered or unexported fields
}

ListKafkaVersionsResponse is the response type for the ListKafkaVersions API operation.

func (*ListKafkaVersionsResponse) SDKResponseMetdata added in v0.20.0 

func (r *ListKafkaVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListKafkaVersions request.

type ListNodesInput 

type ListNodesInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListNodesInput) MarshalFields 

func (s ListNodesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListNodesInput) String 

func (s ListNodesInput) String() string

String returns the string representation

func (*ListNodesInput) Validate 

func (s *ListNodesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"nextToken" type:"string"`

	// List containing a NodeInfo object.
	NodeInfoList []NodeInfo `locationName:"nodeInfoList" type:"list"`
	// contains filtered or unexported fields
}

Information about nodes in the cluster.

func (ListNodesOutput) MarshalFields 

func (s ListNodesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListNodesOutput) String 

func (s ListNodesOutput) String() string

String returns the string representation

type ListNodesPaginator added in v0.9.0 

type ListNodesPaginator struct {
	aws.Pager
}

ListNodesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListNodesPaginator added in v0.9.0 

func NewListNodesPaginator(req ListNodesRequest) ListNodesPaginator

NewListNodesRequestPaginator returns a paginator for ListNodes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListNodesRequest(input)
p := kafka.NewListNodesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListNodesPaginator) CurrentPage added in v0.9.0 

func (p *ListNodesPaginator) CurrentPage() *ListNodesOutput

type ListNodesRequest 

type ListNodesRequest struct {
	*aws.Request
	Input *ListNodesInput
	Copy  func(*ListNodesInput) ListNodesRequest
}

ListNodesRequest is the request type for the ListNodes API operation.

func (ListNodesRequest) Send 

func (r ListNodesRequest) Send(ctx context.Context) (*ListNodesResponse, error)

Send marshals and sends the ListNodes API request.

type ListNodesResponse added in v0.9.0 

type ListNodesResponse struct {
	*ListNodesOutput
	// contains filtered or unexported fields
}

ListNodesResponse is the response type for the ListNodes API operation.

func (*ListNodesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListNodesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListNodes request.

type ListTagsForResourceInput added in v0.8.0 

type ListTagsForResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.8.0 

type ListTagsForResourceOutput struct {

	// The key-value pair for the resource tag.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Response of listing tags for a resource.

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LoggingInfo added in v0.20.0 

type LoggingInfo struct {

	// You can configure your MSK cluster to send broker logs to different destination
	// types. This configuration specifies the details of these destinations.
	//
	// BrokerLogs is a required field
	BrokerLogs *BrokerLogs `locationName:"brokerLogs" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

func (LoggingInfo) MarshalFields added in v0.20.0 

func (s LoggingInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LoggingInfo) String added in v0.20.0 

func (s LoggingInfo) String() string

String returns the string representation

func (*LoggingInfo) Validate added in v0.20.0 

func (s *LoggingInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MutableClusterInfo added in v0.10.0 

type MutableClusterInfo struct {

	// Specifies the size of the EBS volume and the ID of the associated broker.
	BrokerEBSVolumeInfo []BrokerEBSVolumeInfo `locationName:"brokerEBSVolumeInfo" type:"list"`

	// Information about the changes in the configuration of the brokers.
	ConfigurationInfo *ConfigurationInfo `locationName:"configurationInfo" type:"structure"`

	// Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon
	// CloudWatch for this cluster.
	EnhancedMonitoring EnhancedMonitoring `locationName:"enhancedMonitoring" type:"string" enum:"true"`

	// LoggingInfo details.
	LoggingInfo *LoggingInfo `locationName:"loggingInfo" type:"structure"`

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" type:"integer"`

	// Settings for open monitoring using Prometheus.
	OpenMonitoring *OpenMonitoring `locationName:"openMonitoring" type:"structure"`
	// contains filtered or unexported fields
}

Information about cluster attributes that can be updated via update APIs.

func (MutableClusterInfo) MarshalFields added in v0.10.0 

func (s MutableClusterInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MutableClusterInfo) String added in v0.10.0 

func (s MutableClusterInfo) String() string

String returns the string representation

type NodeExporter added in v0.18.0 

type NodeExporter struct {

	// Indicates whether you want to enable or disable the Node Exporter.
	//
	// EnabledInBroker is a required field
	EnabledInBroker *bool `locationName:"enabledInBroker" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Indicates whether you want to enable or disable the Node Exporter.

func (NodeExporter) MarshalFields added in v0.18.0 

func (s NodeExporter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NodeExporter) String added in v0.18.0 

func (s NodeExporter) String() string

String returns the string representation

type NodeExporterInfo added in v0.18.0 

type NodeExporterInfo struct {

	// Node Exporter being enabled in broker.
	//
	// EnabledInBroker is a required field
	EnabledInBroker *bool `locationName:"enabledInBroker" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Indicates whether you want to enable or disable the Node Exporter.

func (NodeExporterInfo) MarshalFields added in v0.18.0 

func (s NodeExporterInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NodeExporterInfo) String added in v0.18.0 

func (s NodeExporterInfo) String() string

String returns the string representation

func (*NodeExporterInfo) Validate added in v0.18.0 

func (s *NodeExporterInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NodeInfo 

type NodeInfo struct {

	// The start time.
	AddedToClusterTime *string `locationName:"addedToClusterTime" type:"string"`

	// The broker node info.
	BrokerNodeInfo *BrokerNodeInfo `locationName:"brokerNodeInfo" type:"structure"`

	// The instance type.
	InstanceType *string `locationName:"instanceType" type:"string"`

	// The Amazon Resource Name (ARN) of the node.
	NodeARN *string `locationName:"nodeARN" type:"string"`

	// The node type.
	NodeType NodeType `locationName:"nodeType" type:"string" enum:"true"`

	// The ZookeeperNodeInfo.
	ZookeeperNodeInfo *ZookeeperNodeInfo `locationName:"zookeeperNodeInfo" type:"structure"`
	// contains filtered or unexported fields
}

The node information object.

func (NodeInfo) MarshalFields 

func (s NodeInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (NodeInfo) String 

func (s NodeInfo) String() string

String returns the string representation

type NodeType 

type NodeType string

The broker or Zookeeper node. 

const (
	NodeTypeBroker NodeType = "BROKER"
)

Enum values for NodeType

func (NodeType) MarshalValue 

func (enum NodeType) MarshalValue() (string, error)

func (NodeType) MarshalValueBuf 

func (enum NodeType) MarshalValueBuf(b []byte) ([]byte, error)

type OpenMonitoring added in v0.18.0 

type OpenMonitoring struct {

	// Prometheus settings.
	//
	// Prometheus is a required field
	Prometheus *Prometheus `locationName:"prometheus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

JMX and Node monitoring for the MSK cluster.

func (OpenMonitoring) MarshalFields added in v0.18.0 

func (s OpenMonitoring) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OpenMonitoring) String added in v0.18.0 

func (s OpenMonitoring) String() string

String returns the string representation

type OpenMonitoringInfo added in v0.18.0 

type OpenMonitoringInfo struct {

	// Prometheus settings.
	//
	// Prometheus is a required field
	Prometheus *PrometheusInfo `locationName:"prometheus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

JMX and Node monitoring for the MSK cluster.

func (OpenMonitoringInfo) MarshalFields added in v0.18.0 

func (s OpenMonitoringInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (OpenMonitoringInfo) String added in v0.18.0 

func (s OpenMonitoringInfo) String() string

String returns the string representation

func (*OpenMonitoringInfo) Validate added in v0.18.0 

func (s *OpenMonitoringInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Prometheus added in v0.18.0 

type Prometheus struct {

	// Indicates whether you want to enable or disable the JMX Exporter.
	JmxExporter *JmxExporter `locationName:"jmxExporter" type:"structure"`

	// Indicates whether you want to enable or disable the Node Exporter.
	NodeExporter *NodeExporter `locationName:"nodeExporter" type:"structure"`
	// contains filtered or unexported fields
}

Prometheus settings for open monitoring.

func (Prometheus) MarshalFields added in v0.18.0 

func (s Prometheus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Prometheus) String added in v0.18.0 

func (s Prometheus) String() string

String returns the string representation

type PrometheusInfo added in v0.18.0 

type PrometheusInfo struct {

	// JMX Exporter settings.
	JmxExporter *JmxExporterInfo `locationName:"jmxExporter" type:"structure"`

	// Node Exporter settings.
	NodeExporter *NodeExporterInfo `locationName:"nodeExporter" type:"structure"`
	// contains filtered or unexported fields
}

Prometheus settings.

func (PrometheusInfo) MarshalFields added in v0.18.0 

func (s PrometheusInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PrometheusInfo) String added in v0.18.0 

func (s PrometheusInfo) String() string

String returns the string representation

func (*PrometheusInfo) Validate added in v0.18.0 

func (s *PrometheusInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3 added in v0.20.0 

type S3 struct {

	// The name of the S3 bucket that is the destination for broker logs.
	Bucket *string `locationName:"bucket" type:"string"`

	// Specifies whether broker logs get sent to the specified Amazon S3 destination.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The S3 prefix that is the destination for broker logs.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

The details of the Amazon S3 destination for broker logs.

func (S3) MarshalFields added in v0.20.0 

func (s S3) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (S3) String added in v0.20.0 

func (s S3) String() string

String returns the string representation

func (*S3) Validate added in v0.20.0 

func (s *S3) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StorageInfo 

type StorageInfo struct {

	// EBS volume information.
	EbsStorageInfo *EBSStorageInfo `locationName:"ebsStorageInfo" type:"structure"`
	// contains filtered or unexported fields
}

Contains information about storage volumes attached to MSK broker nodes.

func (StorageInfo) MarshalFields 

func (s StorageInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StorageInfo) String 

func (s StorageInfo) String() string

String returns the string representation

func (*StorageInfo) Validate 

func (s *StorageInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The key-value pair for the resource tag.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Tag a resource.

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Tls added in v0.10.0 

type Tls struct {

	// List of ACM Certificate Authority ARNs.
	CertificateAuthorityArnList []string `locationName:"certificateAuthorityArnList" type:"list"`
	// contains filtered or unexported fields
}

Details for client authentication using TLS.

func (Tls) MarshalFields added in v0.10.0 

func (s Tls) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tls) String added in v0.10.0 

func (s Tls) String() string

String returns the string representation

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateBrokerCountInput added in v0.15.0 

type UpdateBrokerCountInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	// The current version of the cluster.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"`

	// The number of broker nodes that you want the cluster to have after this operation
	// completes successfully.
	//
	// TargetNumberOfBrokerNodes is a required field
	TargetNumberOfBrokerNodes *int64 `locationName:"targetNumberOfBrokerNodes" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Request body for UpdateBrokerCount.

func (UpdateBrokerCountInput) MarshalFields added in v0.15.0 

func (s UpdateBrokerCountInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerCountInput) String added in v0.15.0 

func (s UpdateBrokerCountInput) String() string

String returns the string representation

func (*UpdateBrokerCountInput) Validate added in v0.15.0 

func (s *UpdateBrokerCountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBrokerCountOutput added in v0.15.0 

type UpdateBrokerCountOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The Amazon Resource Name (ARN) of the cluster operation.
	ClusterOperationArn *string `locationName:"clusterOperationArn" type:"string"`
	// contains filtered or unexported fields
}

Response body for UpdateBrokerCount.

func (UpdateBrokerCountOutput) MarshalFields added in v0.15.0 

func (s UpdateBrokerCountOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerCountOutput) String added in v0.15.0 

func (s UpdateBrokerCountOutput) String() string

String returns the string representation

type UpdateBrokerCountRequest added in v0.15.0 

type UpdateBrokerCountRequest struct {
	*aws.Request
	Input *UpdateBrokerCountInput
	Copy  func(*UpdateBrokerCountInput) UpdateBrokerCountRequest
}

UpdateBrokerCountRequest is the request type for the UpdateBrokerCount API operation.

func (UpdateBrokerCountRequest) Send added in v0.15.0 

func (r UpdateBrokerCountRequest) Send(ctx context.Context) (*UpdateBrokerCountResponse, error)

Send marshals and sends the UpdateBrokerCount API request.

type UpdateBrokerCountResponse added in v0.15.0 

type UpdateBrokerCountResponse struct {
	*UpdateBrokerCountOutput
	// contains filtered or unexported fields
}

UpdateBrokerCountResponse is the response type for the UpdateBrokerCount API operation.

func (*UpdateBrokerCountResponse) SDKResponseMetdata added in v0.15.0 

func (r *UpdateBrokerCountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateBrokerCount request.

type UpdateBrokerStorageInput added in v0.10.0 

type UpdateBrokerStorageInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	// The version of cluster to update from. A successful operation will then generate
	// a new version.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"`

	// Describes the target volume size and the ID of the broker to apply the update
	// to.
	//
	// The value you specify for Target-Volume-in-GiB must be a whole number that
	// is greater than 100 GiB.
	//
	// The storage per broker after the update operation can't exceed 16384 GiB.
	//
	// TargetBrokerEBSVolumeInfo is a required field
	TargetBrokerEBSVolumeInfo []BrokerEBSVolumeInfo `locationName:"targetBrokerEBSVolumeInfo" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Request object for UpdateBrokerStorage.

func (UpdateBrokerStorageInput) MarshalFields added in v0.10.0 

func (s UpdateBrokerStorageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerStorageInput) String added in v0.10.0 

func (s UpdateBrokerStorageInput) String() string

String returns the string representation

func (*UpdateBrokerStorageInput) Validate added in v0.10.0 

func (s *UpdateBrokerStorageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBrokerStorageOutput added in v0.10.0 

type UpdateBrokerStorageOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The Amazon Resource Name (ARN) of the cluster operation.
	ClusterOperationArn *string `locationName:"clusterOperationArn" type:"string"`
	// contains filtered or unexported fields
}

Response body for UpdateBrokerStorage.

func (UpdateBrokerStorageOutput) MarshalFields added in v0.10.0 

func (s UpdateBrokerStorageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerStorageOutput) String added in v0.10.0 

func (s UpdateBrokerStorageOutput) String() string

String returns the string representation

type UpdateBrokerStorageRequest added in v0.10.0 

type UpdateBrokerStorageRequest struct {
	*aws.Request
	Input *UpdateBrokerStorageInput
	Copy  func(*UpdateBrokerStorageInput) UpdateBrokerStorageRequest
}

UpdateBrokerStorageRequest is the request type for the UpdateBrokerStorage API operation.

func (UpdateBrokerStorageRequest) Send added in v0.10.0 

func (r UpdateBrokerStorageRequest) Send(ctx context.Context) (*UpdateBrokerStorageResponse, error)

Send marshals and sends the UpdateBrokerStorage API request.

type UpdateBrokerStorageResponse added in v0.10.0 

type UpdateBrokerStorageResponse struct {
	*UpdateBrokerStorageOutput
	// contains filtered or unexported fields
}

UpdateBrokerStorageResponse is the response type for the UpdateBrokerStorage API operation.

func (*UpdateBrokerStorageResponse) SDKResponseMetdata added in v0.10.0 

func (r *UpdateBrokerStorageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateBrokerStorage request.

type UpdateClusterConfigurationInput added in v0.10.0 

type UpdateClusterConfigurationInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	// Represents the configuration that you want MSK to use for the cluster.
	//
	// ConfigurationInfo is a required field
	ConfigurationInfo *ConfigurationInfo `locationName:"configurationInfo" type:"structure" required:"true"`

	// The version of the cluster that you want to update.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request body for UpdateClusterConfiguration.

func (UpdateClusterConfigurationInput) MarshalFields added in v0.10.0 

func (s UpdateClusterConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterConfigurationInput) String added in v0.10.0 

func (s UpdateClusterConfigurationInput) String() string

String returns the string representation

func (*UpdateClusterConfigurationInput) Validate added in v0.10.0 

func (s *UpdateClusterConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateClusterConfigurationOutput added in v0.10.0 

type UpdateClusterConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The Amazon Resource Name (ARN) of the cluster operation.
	ClusterOperationArn *string `locationName:"clusterOperationArn" type:"string"`
	// contains filtered or unexported fields
}

Response body for UpdateClusterConfiguration.

func (UpdateClusterConfigurationOutput) MarshalFields added in v0.10.0 

func (s UpdateClusterConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateClusterConfigurationOutput) String added in v0.10.0 

func (s UpdateClusterConfigurationOutput) String() string

String returns the string representation

type UpdateClusterConfigurationRequest added in v0.10.0 

type UpdateClusterConfigurationRequest struct {
	*aws.Request
	Input *UpdateClusterConfigurationInput
	Copy  func(*UpdateClusterConfigurationInput) UpdateClusterConfigurationRequest
}

UpdateClusterConfigurationRequest is the request type for the UpdateClusterConfiguration API operation.

func (UpdateClusterConfigurationRequest) Send added in v0.10.0 

func (r UpdateClusterConfigurationRequest) Send(ctx context.Context) (*UpdateClusterConfigurationResponse, error)

Send marshals and sends the UpdateClusterConfiguration API request.

type UpdateClusterConfigurationResponse added in v0.10.0 

type UpdateClusterConfigurationResponse struct {
	*UpdateClusterConfigurationOutput
	// contains filtered or unexported fields
}

UpdateClusterConfigurationResponse is the response type for the UpdateClusterConfiguration API operation.

func (*UpdateClusterConfigurationResponse) SDKResponseMetdata added in v0.10.0 

func (r *UpdateClusterConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateClusterConfiguration request.

type UpdateMonitoringInput added in v0.18.0 

type UpdateMonitoringInput struct {

	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	// The version of cluster to update from. A successful operation will then generate
	// a new version.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"`

	// Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon
	// CloudWatch for this cluster.
	EnhancedMonitoring EnhancedMonitoring `locationName:"enhancedMonitoring" type:"string" enum:"true"`

	// LoggingInfo details.
	LoggingInfo *LoggingInfo `locationName:"loggingInfo" type:"structure"`

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo `locationName:"openMonitoring" type:"structure"`
	// contains filtered or unexported fields
}

Request body for UpdateMonitoring.

func (UpdateMonitoringInput) MarshalFields added in v0.18.0 

func (s UpdateMonitoringInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateMonitoringInput) String added in v0.18.0 

func (s UpdateMonitoringInput) String() string

String returns the string representation

func (*UpdateMonitoringInput) Validate added in v0.18.0 

func (s *UpdateMonitoringInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMonitoringOutput added in v0.18.0 

type UpdateMonitoringOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	ClusterArn *string `locationName:"clusterArn" type:"string"`

	// The Amazon Resource Name (ARN) of the cluster operation.
	ClusterOperationArn *string `locationName:"clusterOperationArn" type:"string"`
	// contains filtered or unexported fields
}

Response body for UpdateMonitoring.

func (UpdateMonitoringOutput) MarshalFields added in v0.18.0 

func (s UpdateMonitoringOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateMonitoringOutput) String added in v0.18.0 

func (s UpdateMonitoringOutput) String() string

String returns the string representation

type UpdateMonitoringRequest added in v0.18.0 

type UpdateMonitoringRequest struct {
	*aws.Request
	Input *UpdateMonitoringInput
	Copy  func(*UpdateMonitoringInput) UpdateMonitoringRequest
}

UpdateMonitoringRequest is the request type for the UpdateMonitoring API operation.

func (UpdateMonitoringRequest) Send added in v0.18.0 

func (r UpdateMonitoringRequest) Send(ctx context.Context) (*UpdateMonitoringResponse, error)

Send marshals and sends the UpdateMonitoring API request.

type UpdateMonitoringResponse added in v0.18.0 

type UpdateMonitoringResponse struct {
	*UpdateMonitoringOutput
	// contains filtered or unexported fields
}

UpdateMonitoringResponse is the response type for the UpdateMonitoring API operation.

func (*UpdateMonitoringResponse) SDKResponseMetdata added in v0.18.0 

func (r *UpdateMonitoringResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateMonitoring request.

type ZookeeperNodeInfo 

type ZookeeperNodeInfo struct {

	// The attached elastic network interface of the broker.
	AttachedENIId *string `locationName:"attachedENIId" type:"string"`

	// The virtual private cloud (VPC) IP address of the client.
	ClientVpcIpAddress *string `locationName:"clientVpcIpAddress" type:"string"`

	// Endpoints for accessing the ZooKeeper.
	Endpoints []string `locationName:"endpoints" type:"list"`

	// The role-specific ID for Zookeeper.
	ZookeeperId *float64 `locationName:"zookeeperId" type:"double"`

	// The version of Zookeeper.
	ZookeeperVersion *string `locationName:"zookeeperVersion" type:"string"`
	// contains filtered or unexported fields
}

Zookeeper node information.

func (ZookeeperNodeInfo) MarshalFields 

func (s ZookeeperNodeInfo) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ZookeeperNodeInfo) String 

func (s ZookeeperNodeInfo) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package kafkaiface provides an interface to enable mocking the Managed Streaming for Kafka service client for testing your code.
 Package kafkaiface provides an interface to enable mocking the Managed Streaming for Kafka service client for testing your code.

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.