kafka

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: May 28, 2019 License: Apache-2.0 Imports: 7 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. This is prerelease documentation for a service in preview release. It is subject to change

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

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) 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) 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 clusters in an account. 

// 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) 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 for this account. 

// 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) 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.

List tags for a 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.

Add tags to a 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.

Remove tags from a resource. 

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

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) 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 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:"unix" required:"true"`

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

	// KafkaVersions is a required field
	KafkaVersions []string `locationName:"kafkaVersions" type:"list" required:"true"`

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

	// The name of the configuration.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an MSK Configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/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 Kafka configuration to use for the brokers. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ConfigurationInfo

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

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

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

	// Comprises of the Configuration to be used on Kafka brokers in a 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"`

	// 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) 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) 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.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contents of the server.properties file. When using the API, you must ensure
	// that the contents of the file are base64 encoded. When using the AWS Management
	// Console, the SDK, or the AWS CLI, the contents of server.properties can be
	// in plaintext.
	//
	// ServerProperties 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateConfigurationRequest

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

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

	// The name of the configuration.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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

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
}

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

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

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

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

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

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

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

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

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
}

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

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

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

	Revision *int64 `locationName:"revision" type:"long"`

	// Contents of the server.properties file. When using the API, you must ensure
	// that the contents of the file are base64 encoded. When using the AWS Management
	// Console, the SDK, or the AWS CLI, the contents of server.properties can be
	// in plaintext.
	//
	// ServerProperties is automatically base64 encoded/decoded by the SDK.
	ServerProperties []byte `locationName:"serverProperties" type:"blob"`
	// contains filtered or unexported fields
}

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

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

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) 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) 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) 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) 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 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) 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) 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 ListConfigurationsInput added in v0.9.0 

type ListConfigurationsInput struct {
	MaxResults *string `location:"querystring" locationName:"maxResults" type:"string"`

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

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

type ListConfigurationsOutput added in v0.9.0 

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

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

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

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 pairs indicating resource tags.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

List tags for a resource Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListTagsForResourceResponse

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 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) 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) 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 pairs indicating resource tags.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Add tags for a resource Please also see https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/TagResourceRequest

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
}

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

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 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
}

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

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
}

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

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