package kafka

import "github.com/aws/aws-sdk-go-v2/service/kafka"

Package kafka provides the client and types for making API requests to Managed Streaming for 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 Managed Streaming for 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 Managed Streaming for Kafka client Kafka for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kafka/#New

Index

Constants 

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"
)
const (
	ServiceName = "kafka"     // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Types

type BrokerAZDistribution 

type BrokerAZDistribution string

The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among three Availability Zones. 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 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.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BrokerNodeGroupInfo

func (BrokerNodeGroupInfo) GoString 

func (s BrokerNodeGroupInfo) GoString() string

GoString returns the string representation

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

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

func (BrokerNodeInfo) GoString 

func (s BrokerNodeInfo) GoString() string

GoString returns the string representation

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.
	ConfigurationArn *string `locationName:"configurationArn" type:"string"`

	// The revision of the configuration to use.
	ConfigurationRevision *string `locationName:"configurationRevision" type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BrokerSoftwareInfo

func (BrokerSoftwareInfo) GoString 

func (s BrokerSoftwareInfo) GoString() string

GoString returns the string representation

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 ClusterInfo 

type ClusterInfo struct {

	// Information about the broker nodes.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" 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:"unix"`

	// 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.
	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.
	EnhancedMonitoring EnhancedMonitoring `locationName:"enhancedMonitoring" type:"string" enum:"true"`

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

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ClusterInfo

func (ClusterInfo) GoString 

func (s ClusterInfo) GoString() string

GoString returns the string representation

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 ClusterState 

type ClusterState string

The state of a Kafka cluster. 

const (
	ClusterStateActive   ClusterState = "ACTIVE"
	ClusterStateCreating ClusterState = "CREATING"
	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 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"`

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

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

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

Creates a cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateClusterRequest

func (CreateClusterInput) GoString 

func (s CreateClusterInput) GoString() string

GoString returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateClusterResponse

func (CreateClusterOutput) GoString 

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s CreateClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the CreateCluster API operation.

func (CreateClusterRequest) Send 

func (r CreateClusterRequest) Send() (*CreateClusterOutput, error)

Send marshals and sends the CreateCluster API 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
}

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

func (DeleteClusterInput) GoString 

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DeleteClusterResponse

func (DeleteClusterOutput) GoString 

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s DeleteClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send 

func (r DeleteClusterRequest) Send() (*DeleteClusterOutput, error)

Send marshals and sends the DeleteCluster API 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
}

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

func (DescribeClusterInput) GoString 

func (s DescribeClusterInput) GoString() string

GoString returns the string representation

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 DescribeClusterOutput 

type DescribeClusterOutput struct {

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

Returns information about a cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeClusterResponse

func (DescribeClusterOutput) GoString 

func (s DescribeClusterOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s DescribeClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the DescribeCluster API operation.

func (DescribeClusterRequest) Send 

func (r DescribeClusterRequest) Send() (*DescribeClusterOutput, error)

Send marshals and sends the DescribeCluster API 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/EBSStorageInfo

func (EBSStorageInfo) GoString 

func (s EBSStorageInfo) GoString() string

GoString returns the string representation

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 AWS KMS key used for data encryption.
	//
	// DataVolumeKMSKeyId is a required field
	DataVolumeKMSKeyId *string `locationName:"dataVolumeKMSKeyId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The data volume encryption details. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/EncryptionAtRest

func (EncryptionAtRest) GoString 

func (s EncryptionAtRest) GoString() string

GoString returns the string representation

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 EncryptionInfo 

type EncryptionInfo struct {

	// The data volume encryption details.
	EncryptionAtRest *EncryptionAtRest `locationName:"encryptionAtRest" type:"structure"`
	// contains filtered or unexported fields
}

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/EncryptionInfo

func (EncryptionInfo) GoString 

func (s EncryptionInfo) GoString() string

GoString returns the string representation

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. 

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 GetBootstrapBrokersInput 

type GetBootstrapBrokersInput struct {

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

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

func (GetBootstrapBrokersInput) GoString 

func (s GetBootstrapBrokersInput) GoString() string

GoString returns the string representation

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

Returns a string containing one or more hostname:port pairs. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetBootstrapBrokersResponse

func (GetBootstrapBrokersOutput) GoString 

func (s GetBootstrapBrokersOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s GetBootstrapBrokersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the GetBootstrapBrokers API operation.

func (GetBootstrapBrokersRequest) Send 

func (r GetBootstrapBrokersRequest) Send() (*GetBootstrapBrokersOutput, error)

Send marshals and sends the GetBootstrapBrokers API request.

type Kafka 

type Kafka struct {
	*aws.Client
}

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

Kafka 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) *Kafka

New creates a new instance of the Kafka client with a config.

Example: 

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

func (*Kafka) CreateClusterRequest 

func (c *Kafka) 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 the CreateClusterRequest method.
req := client.CreateClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Kafka) DeleteClusterRequest 

func (c *Kafka) 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 the DeleteClusterRequest method.
req := client.DeleteClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Kafka) DescribeClusterRequest 

func (c *Kafka) 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 the DescribeClusterRequest method.
req := client.DescribeClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Kafka) GetBootstrapBrokersRequest 

func (c *Kafka) 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 the GetBootstrapBrokersRequest method.
req := client.GetBootstrapBrokersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*Kafka) ListClustersRequest 

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

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

Returns a list of clusters in an account. 

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

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

func (*Kafka) ListNodesRequest 

func (c *Kafka) 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 the ListNodesRequest method.
req := client.ListNodesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

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
}

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

func (ListClustersInput) GoString 

func (s ListClustersInput) GoString() string

GoString returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListClustersResponse

func (ListClustersOutput) GoString 

func (s ListClustersOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s ListClustersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListClustersOutput) String 

func (s ListClustersOutput) String() string

String returns the string representation

type ListClustersRequest 

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

ListClustersRequest is a API request type for the ListClusters API operation.

func (ListClustersRequest) Send 

func (r ListClustersRequest) Send() (*ListClustersOutput, error)

Send marshals and sends the ListClusters API 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
}

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

func (ListNodesInput) GoString 

func (s ListNodesInput) GoString() string

GoString returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListNodesResponse

func (ListNodesOutput) GoString 

func (s ListNodesOutput) GoString() string

GoString returns the string representation

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) SDKResponseMetadata 

func (s ListNodesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListNodesOutput) String 

func (s ListNodesOutput) String() string

String returns the string representation

type ListNodesRequest 

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

ListNodesRequest is a API request type for the ListNodes API operation.

func (ListNodesRequest) Send 

func (r ListNodesRequest) Send() (*ListNodesOutput, error)

Send marshals and sends the ListNodes API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/NodeInfo

func (NodeInfo) GoString 

func (s NodeInfo) GoString() string

GoString returns the string representation

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/StorageInfo

func (StorageInfo) GoString 

func (s StorageInfo) GoString() string

GoString returns the string representation

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 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"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ZookeeperNodeInfo

func (ZookeeperNodeInfo) GoString 

func (s ZookeeperNodeInfo) GoString() string

GoString returns the string representation

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

api.go doc.go errors.go service.go

Directories

PathSynopsis
service/kafka/kafkaifacePackage kafkaiface provides an interface to enable mocking the Managed Streaming for Kafka service client for testing your code.
Version
v0.7.0
Published
Jan 3, 2019
Platform
windows/amd64
Imports
6 packages
Last checked
3 minutes ago –

Tools for package owners.