kafka

package
v1.37.29 Latest Latest
Warning

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

Go to latest
Published: Mar 11, 2021 License: Apache-2.0 Imports: 10 Imported by: 67

Documentation

Overview

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

View Source
const (
	// ClientBrokerTls is a ClientBroker enum value
	ClientBrokerTls = "TLS"

	// ClientBrokerTlsPlaintext is a ClientBroker enum value
	ClientBrokerTlsPlaintext = "TLS_PLAINTEXT"

	// ClientBrokerPlaintext is a ClientBroker enum value
	ClientBrokerPlaintext = "PLAINTEXT"
)

Client-broker encryption in transit setting.

View Source
const (
	// ClusterStateActive is a ClusterState enum value
	ClusterStateActive = "ACTIVE"

	// ClusterStateCreating is a ClusterState enum value
	ClusterStateCreating = "CREATING"

	// ClusterStateDeleting is a ClusterState enum value
	ClusterStateDeleting = "DELETING"

	// ClusterStateFailed is a ClusterState enum value
	ClusterStateFailed = "FAILED"

	// ClusterStateHealing is a ClusterState enum value
	ClusterStateHealing = "HEALING"

	// ClusterStateMaintenance is a ClusterState enum value
	ClusterStateMaintenance = "MAINTENANCE"

	// ClusterStateRebootingBroker is a ClusterState enum value
	ClusterStateRebootingBroker = "REBOOTING_BROKER"

	// ClusterStateUpdating is a ClusterState enum value
	ClusterStateUpdating = "UPDATING"
)

The state of a Kafka cluster.

View Source
const (
	// ConfigurationStateActive is a ConfigurationState enum value
	ConfigurationStateActive = "ACTIVE"

	// ConfigurationStateDeleting is a ConfigurationState enum value
	ConfigurationStateDeleting = "DELETING"

	// ConfigurationStateDeleteFailed is a ConfigurationState enum value
	ConfigurationStateDeleteFailed = "DELETE_FAILED"
)

The state of a configuration.

View Source
const (
	// EnhancedMonitoringDefault is a EnhancedMonitoring enum value
	EnhancedMonitoringDefault = "DEFAULT"

	// EnhancedMonitoringPerBroker is a EnhancedMonitoring enum value
	EnhancedMonitoringPerBroker = "PER_BROKER"

	// EnhancedMonitoringPerTopicPerBroker is a EnhancedMonitoring enum value
	EnhancedMonitoringPerTopicPerBroker = "PER_TOPIC_PER_BROKER"

	// EnhancedMonitoringPerTopicPerPartition is a EnhancedMonitoring enum value
	EnhancedMonitoringPerTopicPerPartition = "PER_TOPIC_PER_PARTITION"
)

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

View Source
const (
	// KafkaVersionStatusActive is a KafkaVersionStatus enum value
	KafkaVersionStatusActive = "ACTIVE"

	// KafkaVersionStatusDeprecated is a KafkaVersionStatus enum value
	KafkaVersionStatusDeprecated = "DEPRECATED"
)

The status of a Kafka version.

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"
)
View Source
const (
	ServiceName = "Kafka" // Name of service.
	EndpointsID = "kafka" // ID to lookup a service endpoint with.
	ServiceID   = "Kafka" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// BrokerAZDistributionDefault is a BrokerAZDistribution enum value
	BrokerAZDistributionDefault = "DEFAULT"
)

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

View Source
const (
	// NodeTypeBroker is a NodeType enum value
	NodeTypeBroker = "BROKER"
)

The broker or Zookeeper node.

Variables

This section is empty.

Functions

func BrokerAZDistribution_Values added in v1.34.3

func BrokerAZDistribution_Values() []string

BrokerAZDistribution_Values returns all elements of the BrokerAZDistribution enum

func ClientBroker_Values added in v1.34.3

func ClientBroker_Values() []string

ClientBroker_Values returns all elements of the ClientBroker enum

func ClusterState_Values added in v1.34.3

func ClusterState_Values() []string

ClusterState_Values returns all elements of the ClusterState enum

func ConfigurationState_Values added in v1.34.10

func ConfigurationState_Values() []string

ConfigurationState_Values returns all elements of the ConfigurationState enum

func EnhancedMonitoring_Values added in v1.34.3

func EnhancedMonitoring_Values() []string

EnhancedMonitoring_Values returns all elements of the EnhancedMonitoring enum

func KafkaVersionStatus_Values added in v1.34.3

func KafkaVersionStatus_Values() []string

KafkaVersionStatus_Values returns all elements of the KafkaVersionStatus enum

func NodeType_Values added in v1.34.3

func NodeType_Values() []string

NodeType_Values returns all elements of the NodeType enum

Types

type BadRequestException added in v1.28.0

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*BadRequestException) Code added in v1.28.0

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message added in v1.28.0

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String added in v1.28.0

func (s BadRequestException) String() string

String returns the string representation

type BatchAssociateScramSecretInput added in v1.34.24

type BatchAssociateScramSecretInput struct {

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

	// List of AWS Secrets Manager secret ARNs.
	//
	// SecretArnList is a required field
	SecretArnList []*string `locationName:"secretArnList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Request body for BatchAssociateScramSecret.

func (BatchAssociateScramSecretInput) GoString added in v1.34.24

GoString returns the string representation

func (*BatchAssociateScramSecretInput) SetClusterArn added in v1.34.24

SetClusterArn sets the ClusterArn field's value.

func (*BatchAssociateScramSecretInput) SetSecretArnList added in v1.34.24

SetSecretArnList sets the SecretArnList field's value.

func (BatchAssociateScramSecretInput) String added in v1.34.24

String returns the string representation

func (*BatchAssociateScramSecretInput) Validate added in v1.34.24

func (s *BatchAssociateScramSecretInput) Validate() error

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

type BatchAssociateScramSecretOutput added in v1.34.24

type BatchAssociateScramSecretOutput struct {

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

	// List of errors when associating secrets to cluster.
	UnprocessedScramSecrets []*UnprocessedScramSecret `locationName:"unprocessedScramSecrets" type:"list"`
	// contains filtered or unexported fields
}

Response body for BatchAssociateScramSecret.

func (BatchAssociateScramSecretOutput) GoString added in v1.34.24

GoString returns the string representation

func (*BatchAssociateScramSecretOutput) SetClusterArn added in v1.34.24

SetClusterArn sets the ClusterArn field's value.

func (*BatchAssociateScramSecretOutput) SetUnprocessedScramSecrets added in v1.34.24

SetUnprocessedScramSecrets sets the UnprocessedScramSecrets field's value.

func (BatchAssociateScramSecretOutput) String added in v1.34.24

String returns the string representation

type BatchDisassociateScramSecretInput added in v1.34.24

type BatchDisassociateScramSecretInput struct {

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

	// List of AWS Secrets Manager secret ARNs.
	//
	// SecretArnList is a required field
	SecretArnList []*string `locationName:"secretArnList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Request body for BatchDisassociateScramSecret.

func (BatchDisassociateScramSecretInput) GoString added in v1.34.24

GoString returns the string representation

func (*BatchDisassociateScramSecretInput) SetClusterArn added in v1.34.24

SetClusterArn sets the ClusterArn field's value.

func (*BatchDisassociateScramSecretInput) SetSecretArnList added in v1.34.24

SetSecretArnList sets the SecretArnList field's value.

func (BatchDisassociateScramSecretInput) String added in v1.34.24

String returns the string representation

func (*BatchDisassociateScramSecretInput) Validate added in v1.34.24

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

type BatchDisassociateScramSecretOutput added in v1.34.24

type BatchDisassociateScramSecretOutput struct {

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

	// List of errors when disassociating secrets to cluster.
	UnprocessedScramSecrets []*UnprocessedScramSecret `locationName:"unprocessedScramSecrets" type:"list"`
	// contains filtered or unexported fields
}

Response body for BatchDisassociateScramSecret.

func (BatchDisassociateScramSecretOutput) GoString added in v1.34.24

GoString returns the string representation

func (*BatchDisassociateScramSecretOutput) SetClusterArn added in v1.34.24

SetClusterArn sets the ClusterArn field's value.

func (*BatchDisassociateScramSecretOutput) SetUnprocessedScramSecrets added in v1.34.24

SetUnprocessedScramSecrets sets the UnprocessedScramSecrets field's value.

func (BatchDisassociateScramSecretOutput) String added in v1.34.24

String returns the string representation

type BrokerEBSVolumeInfo added in v1.19.41

type BrokerEBSVolumeInfo struct {

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

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

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

func (BrokerEBSVolumeInfo) GoString added in v1.19.41

func (s BrokerEBSVolumeInfo) GoString() string

GoString returns the string representation

func (*BrokerEBSVolumeInfo) SetKafkaBrokerNodeId added in v1.19.41

func (s *BrokerEBSVolumeInfo) SetKafkaBrokerNodeId(v string) *BrokerEBSVolumeInfo

SetKafkaBrokerNodeId sets the KafkaBrokerNodeId field's value.

func (*BrokerEBSVolumeInfo) SetVolumeSizeGB added in v1.19.41

func (s *BrokerEBSVolumeInfo) SetVolumeSizeGB(v int64) *BrokerEBSVolumeInfo

SetVolumeSizeGB sets the VolumeSizeGB field's value.

func (BrokerEBSVolumeInfo) String added in v1.19.41

func (s BrokerEBSVolumeInfo) String() string

String returns the string representation

func (*BrokerEBSVolumeInfo) Validate added in v1.19.41

func (s *BrokerEBSVolumeInfo) Validate() error

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

type BrokerLogs added in v1.29.10

type BrokerLogs struct {

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

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

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

The broker logs configuration for this MSK cluster.

func (BrokerLogs) GoString added in v1.29.10

func (s BrokerLogs) GoString() string

GoString returns the string representation

func (*BrokerLogs) SetCloudWatchLogs added in v1.29.10

func (s *BrokerLogs) SetCloudWatchLogs(v *CloudWatchLogs) *BrokerLogs

SetCloudWatchLogs sets the CloudWatchLogs field's value.

func (*BrokerLogs) SetFirehose added in v1.29.10

func (s *BrokerLogs) SetFirehose(v *Firehose) *BrokerLogs

SetFirehose sets the Firehose field's value.

func (*BrokerLogs) SetS3 added in v1.29.10

func (s *BrokerLogs) SetS3(v *S3) *BrokerLogs

SetS3 sets the S3 field's value.

func (BrokerLogs) String added in v1.29.10

func (s BrokerLogs) String() string

String returns the string representation

func (*BrokerLogs) Validate added in v1.29.10

func (s *BrokerLogs) Validate() error

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

type BrokerNodeGroupInfo

type BrokerNodeGroupInfo struct {

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

	// 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 broker used in the Amazon MSK cluster.
	//
	// InstanceType is a required field
	InstanceType *string `locationName:"instanceType" min:"5" type:"string" required:"true"`

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

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

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

func (BrokerNodeGroupInfo) GoString

func (s BrokerNodeGroupInfo) GoString() string

GoString returns the string representation

func (*BrokerNodeGroupInfo) SetBrokerAZDistribution

func (s *BrokerNodeGroupInfo) SetBrokerAZDistribution(v string) *BrokerNodeGroupInfo

SetBrokerAZDistribution sets the BrokerAZDistribution field's value.

func (*BrokerNodeGroupInfo) SetClientSubnets

func (s *BrokerNodeGroupInfo) SetClientSubnets(v []*string) *BrokerNodeGroupInfo

SetClientSubnets sets the ClientSubnets field's value.

func (*BrokerNodeGroupInfo) SetInstanceType

func (s *BrokerNodeGroupInfo) SetInstanceType(v string) *BrokerNodeGroupInfo

SetInstanceType sets the InstanceType field's value.

func (*BrokerNodeGroupInfo) SetSecurityGroups

func (s *BrokerNodeGroupInfo) SetSecurityGroups(v []*string) *BrokerNodeGroupInfo

SetSecurityGroups sets the SecurityGroups field's value.

func (*BrokerNodeGroupInfo) SetStorageInfo

func (s *BrokerNodeGroupInfo) SetStorageInfo(v *StorageInfo) *BrokerNodeGroupInfo

SetStorageInfo sets the StorageInfo field's value.

func (BrokerNodeGroupInfo) String

func (s BrokerNodeGroupInfo) String() string

String returns the string representation

func (*BrokerNodeGroupInfo) Validate

func (s *BrokerNodeGroupInfo) Validate() error

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

type BrokerNodeInfo

type BrokerNodeInfo struct {

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

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

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

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

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

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

BrokerNodeInfo

func (BrokerNodeInfo) GoString

func (s BrokerNodeInfo) GoString() string

GoString returns the string representation

func (*BrokerNodeInfo) SetAttachedENIId

func (s *BrokerNodeInfo) SetAttachedENIId(v string) *BrokerNodeInfo

SetAttachedENIId sets the AttachedENIId field's value.

func (*BrokerNodeInfo) SetBrokerId

func (s *BrokerNodeInfo) SetBrokerId(v float64) *BrokerNodeInfo

SetBrokerId sets the BrokerId field's value.

func (*BrokerNodeInfo) SetClientSubnet

func (s *BrokerNodeInfo) SetClientSubnet(v string) *BrokerNodeInfo

SetClientSubnet sets the ClientSubnet field's value.

func (*BrokerNodeInfo) SetClientVpcIpAddress

func (s *BrokerNodeInfo) SetClientVpcIpAddress(v string) *BrokerNodeInfo

SetClientVpcIpAddress sets the ClientVpcIpAddress field's value.

func (*BrokerNodeInfo) SetCurrentBrokerSoftwareInfo

func (s *BrokerNodeInfo) SetCurrentBrokerSoftwareInfo(v *BrokerSoftwareInfo) *BrokerNodeInfo

SetCurrentBrokerSoftwareInfo sets the CurrentBrokerSoftwareInfo field's value.

func (*BrokerNodeInfo) SetEndpoints added in v1.19.41

func (s *BrokerNodeInfo) SetEndpoints(v []*string) *BrokerNodeInfo

SetEndpoints sets the Endpoints field's value.

func (BrokerNodeInfo) String

func (s BrokerNodeInfo) String() string

String returns the string representation

type BrokerSoftwareInfo

type BrokerSoftwareInfo struct {

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

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

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

Information about the current software installed on the cluster.

func (BrokerSoftwareInfo) GoString

func (s BrokerSoftwareInfo) GoString() string

GoString returns the string representation

func (*BrokerSoftwareInfo) SetConfigurationArn

func (s *BrokerSoftwareInfo) SetConfigurationArn(v string) *BrokerSoftwareInfo

SetConfigurationArn sets the ConfigurationArn field's value.

func (*BrokerSoftwareInfo) SetConfigurationRevision

func (s *BrokerSoftwareInfo) SetConfigurationRevision(v int64) *BrokerSoftwareInfo

SetConfigurationRevision sets the ConfigurationRevision field's value.

func (*BrokerSoftwareInfo) SetKafkaVersion

func (s *BrokerSoftwareInfo) SetKafkaVersion(v string) *BrokerSoftwareInfo

SetKafkaVersion sets the KafkaVersion field's value.

func (BrokerSoftwareInfo) String

func (s BrokerSoftwareInfo) String() string

String returns the string representation

type ClientAuthentication added in v1.19.41

type ClientAuthentication struct {
	Sasl *Sasl `locationName:"sasl" type:"structure"`

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

Includes all client authentication information.

func (ClientAuthentication) GoString added in v1.19.41

func (s ClientAuthentication) GoString() string

GoString returns the string representation

func (*ClientAuthentication) SetSasl added in v1.34.24

SetSasl sets the Sasl field's value.

func (*ClientAuthentication) SetTls added in v1.19.41

SetTls sets the Tls field's value.

func (ClientAuthentication) String added in v1.19.41

func (s ClientAuthentication) String() string

String returns the string representation

type CloudWatchLogs added in v1.29.10

type CloudWatchLogs struct {

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

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

Details of the CloudWatch Logs destination for broker logs.

func (CloudWatchLogs) GoString added in v1.29.10

func (s CloudWatchLogs) GoString() string

GoString returns the string representation

func (*CloudWatchLogs) SetEnabled added in v1.29.10

func (s *CloudWatchLogs) SetEnabled(v bool) *CloudWatchLogs

SetEnabled sets the Enabled field's value.

func (*CloudWatchLogs) SetLogGroup added in v1.29.10

func (s *CloudWatchLogs) SetLogGroup(v string) *CloudWatchLogs

SetLogGroup sets the LogGroup field's value.

func (CloudWatchLogs) String added in v1.29.10

func (s CloudWatchLogs) String() string

String returns the string representation

func (*CloudWatchLogs) Validate added in v1.29.10

func (s *CloudWatchLogs) Validate() error

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

type ClusterInfo

type ClusterInfo struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

	// The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State *string `locationName:"state" type:"string" enum:"ClusterState"`

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

	// The connection string to use to connect to the Apache ZooKeeper cluster.
	ZookeeperConnectString *string `locationName:"zookeeperConnectString" type:"string"`

	// The connection string to use to connect to zookeeper cluster on Tls port.
	ZookeeperConnectStringTls *string `locationName:"zookeeperConnectStringTls" type:"string"`
	// contains filtered or unexported fields
}

Returns information about a cluster.

func (ClusterInfo) GoString

func (s ClusterInfo) GoString() string

GoString returns the string representation

func (*ClusterInfo) SetActiveOperationArn added in v1.19.41

func (s *ClusterInfo) SetActiveOperationArn(v string) *ClusterInfo

SetActiveOperationArn sets the ActiveOperationArn field's value.

func (*ClusterInfo) SetBrokerNodeGroupInfo

func (s *ClusterInfo) SetBrokerNodeGroupInfo(v *BrokerNodeGroupInfo) *ClusterInfo

SetBrokerNodeGroupInfo sets the BrokerNodeGroupInfo field's value.

func (*ClusterInfo) SetClientAuthentication added in v1.19.41

func (s *ClusterInfo) SetClientAuthentication(v *ClientAuthentication) *ClusterInfo

SetClientAuthentication sets the ClientAuthentication field's value.

func (*ClusterInfo) SetClusterArn

func (s *ClusterInfo) SetClusterArn(v string) *ClusterInfo

SetClusterArn sets the ClusterArn field's value.

func (*ClusterInfo) SetClusterName

func (s *ClusterInfo) SetClusterName(v string) *ClusterInfo

SetClusterName sets the ClusterName field's value.

func (*ClusterInfo) SetCreationTime

func (s *ClusterInfo) SetCreationTime(v time.Time) *ClusterInfo

SetCreationTime sets the CreationTime field's value.

func (*ClusterInfo) SetCurrentBrokerSoftwareInfo

func (s *ClusterInfo) SetCurrentBrokerSoftwareInfo(v *BrokerSoftwareInfo) *ClusterInfo

SetCurrentBrokerSoftwareInfo sets the CurrentBrokerSoftwareInfo field's value.

func (*ClusterInfo) SetCurrentVersion

func (s *ClusterInfo) SetCurrentVersion(v string) *ClusterInfo

SetCurrentVersion sets the CurrentVersion field's value.

func (*ClusterInfo) SetEncryptionInfo

func (s *ClusterInfo) SetEncryptionInfo(v *EncryptionInfo) *ClusterInfo

SetEncryptionInfo sets the EncryptionInfo field's value.

func (*ClusterInfo) SetEnhancedMonitoring

func (s *ClusterInfo) SetEnhancedMonitoring(v string) *ClusterInfo

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*ClusterInfo) SetLoggingInfo added in v1.29.10

func (s *ClusterInfo) SetLoggingInfo(v *LoggingInfo) *ClusterInfo

SetLoggingInfo sets the LoggingInfo field's value.

func (*ClusterInfo) SetNumberOfBrokerNodes

func (s *ClusterInfo) SetNumberOfBrokerNodes(v int64) *ClusterInfo

SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value.

func (*ClusterInfo) SetOpenMonitoring added in v1.25.49

func (s *ClusterInfo) SetOpenMonitoring(v *OpenMonitoring) *ClusterInfo

SetOpenMonitoring sets the OpenMonitoring field's value.

func (*ClusterInfo) SetState

func (s *ClusterInfo) SetState(v string) *ClusterInfo

SetState sets the State field's value.

func (*ClusterInfo) SetTags added in v1.19.41

func (s *ClusterInfo) SetTags(v map[string]*string) *ClusterInfo

SetTags sets the Tags field's value.

func (*ClusterInfo) SetZookeeperConnectString

func (s *ClusterInfo) SetZookeeperConnectString(v string) *ClusterInfo

SetZookeeperConnectString sets the ZookeeperConnectString field's value.

func (*ClusterInfo) SetZookeeperConnectStringTls added in v1.35.1

func (s *ClusterInfo) SetZookeeperConnectStringTls(v string) *ClusterInfo

SetZookeeperConnectStringTls sets the ZookeeperConnectStringTls field's value.

func (ClusterInfo) String

func (s ClusterInfo) String() string

String returns the string representation

type ClusterOperationInfo added in v1.19.41

type ClusterOperationInfo struct {

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

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

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

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

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

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

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

	// Steps completed during the operation.
	OperationSteps []*ClusterOperationStep `locationName:"operationSteps" type:"list"`

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

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

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

Returns information about a cluster operation.

func (ClusterOperationInfo) GoString added in v1.19.41

func (s ClusterOperationInfo) GoString() string

GoString returns the string representation

func (*ClusterOperationInfo) SetClientRequestId added in v1.19.41

func (s *ClusterOperationInfo) SetClientRequestId(v string) *ClusterOperationInfo

SetClientRequestId sets the ClientRequestId field's value.

func (*ClusterOperationInfo) SetClusterArn added in v1.19.41

func (s *ClusterOperationInfo) SetClusterArn(v string) *ClusterOperationInfo

SetClusterArn sets the ClusterArn field's value.

func (*ClusterOperationInfo) SetCreationTime added in v1.19.41

func (s *ClusterOperationInfo) SetCreationTime(v time.Time) *ClusterOperationInfo

SetCreationTime sets the CreationTime field's value.

func (*ClusterOperationInfo) SetEndTime added in v1.19.41

SetEndTime sets the EndTime field's value.

func (*ClusterOperationInfo) SetErrorInfo added in v1.19.41

SetErrorInfo sets the ErrorInfo field's value.

func (*ClusterOperationInfo) SetOperationArn added in v1.19.41

func (s *ClusterOperationInfo) SetOperationArn(v string) *ClusterOperationInfo

SetOperationArn sets the OperationArn field's value.

func (*ClusterOperationInfo) SetOperationState added in v1.19.41

func (s *ClusterOperationInfo) SetOperationState(v string) *ClusterOperationInfo

SetOperationState sets the OperationState field's value.

func (*ClusterOperationInfo) SetOperationSteps added in v1.31.7

SetOperationSteps sets the OperationSteps field's value.

func (*ClusterOperationInfo) SetOperationType added in v1.19.41

func (s *ClusterOperationInfo) SetOperationType(v string) *ClusterOperationInfo

SetOperationType sets the OperationType field's value.

func (*ClusterOperationInfo) SetSourceClusterInfo added in v1.19.41

func (s *ClusterOperationInfo) SetSourceClusterInfo(v *MutableClusterInfo) *ClusterOperationInfo

SetSourceClusterInfo sets the SourceClusterInfo field's value.

func (*ClusterOperationInfo) SetTargetClusterInfo added in v1.19.41

func (s *ClusterOperationInfo) SetTargetClusterInfo(v *MutableClusterInfo) *ClusterOperationInfo

SetTargetClusterInfo sets the TargetClusterInfo field's value.

func (ClusterOperationInfo) String added in v1.19.41

func (s ClusterOperationInfo) String() string

String returns the string representation

type ClusterOperationStep added in v1.31.7

type ClusterOperationStep struct {

	// Information about the step and its status.
	StepInfo *ClusterOperationStepInfo `locationName:"stepInfo" type:"structure"`

	// The name of the step.
	StepName *string `locationName:"stepName" type:"string"`
	// contains filtered or unexported fields
}

Step taken during a cluster operation.

func (ClusterOperationStep) GoString added in v1.31.7

func (s ClusterOperationStep) GoString() string

GoString returns the string representation

func (*ClusterOperationStep) SetStepInfo added in v1.31.7

SetStepInfo sets the StepInfo field's value.

func (*ClusterOperationStep) SetStepName added in v1.31.7

SetStepName sets the StepName field's value.

func (ClusterOperationStep) String added in v1.31.7

func (s ClusterOperationStep) String() string

String returns the string representation

type ClusterOperationStepInfo added in v1.31.7

type ClusterOperationStepInfo struct {

	// The steps current status.
	StepStatus *string `locationName:"stepStatus" type:"string"`
	// contains filtered or unexported fields
}

State information about the operation step.

func (ClusterOperationStepInfo) GoString added in v1.31.7

func (s ClusterOperationStepInfo) GoString() string

GoString returns the string representation

func (*ClusterOperationStepInfo) SetStepStatus added in v1.31.7

SetStepStatus sets the StepStatus field's value.

func (ClusterOperationStepInfo) String added in v1.31.7

func (s ClusterOperationStepInfo) String() string

String returns the string representation

type CompatibleKafkaVersion added in v1.31.7

type CompatibleKafkaVersion struct {
	SourceVersion *string `locationName:"sourceVersion" type:"string"`

	TargetVersions []*string `locationName:"targetVersions" type:"list"`
	// contains filtered or unexported fields
}

Contains source Kafka versions and compatible target Kafka versions.

func (CompatibleKafkaVersion) GoString added in v1.31.7

func (s CompatibleKafkaVersion) GoString() string

GoString returns the string representation

func (*CompatibleKafkaVersion) SetSourceVersion added in v1.31.7

func (s *CompatibleKafkaVersion) SetSourceVersion(v string) *CompatibleKafkaVersion

SetSourceVersion sets the SourceVersion field's value.

func (*CompatibleKafkaVersion) SetTargetVersions added in v1.31.7

func (s *CompatibleKafkaVersion) SetTargetVersions(v []*string) *CompatibleKafkaVersion

SetTargetVersions sets the TargetVersions field's value.

func (CompatibleKafkaVersion) String added in v1.31.7

func (s CompatibleKafkaVersion) String() string

String returns the string representation

type Configuration added in v1.19.34

type Configuration struct {

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

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

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

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

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

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

	// The state of a configuration.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"ConfigurationState"`
	// contains filtered or unexported fields
}

Represents an MSK Configuration.

func (Configuration) GoString added in v1.19.34

func (s Configuration) GoString() string

GoString returns the string representation

func (*Configuration) SetArn added in v1.19.34

func (s *Configuration) SetArn(v string) *Configuration

SetArn sets the Arn field's value.

func (*Configuration) SetCreationTime added in v1.19.34

func (s *Configuration) SetCreationTime(v time.Time) *Configuration

SetCreationTime sets the CreationTime field's value.

func (*Configuration) SetDescription added in v1.19.34

func (s *Configuration) SetDescription(v string) *Configuration

SetDescription sets the Description field's value.

func (*Configuration) SetKafkaVersions added in v1.19.34

func (s *Configuration) SetKafkaVersions(v []*string) *Configuration

SetKafkaVersions sets the KafkaVersions field's value.

func (*Configuration) SetLatestRevision added in v1.19.34

func (s *Configuration) SetLatestRevision(v *ConfigurationRevision) *Configuration

SetLatestRevision sets the LatestRevision field's value.

func (*Configuration) SetName added in v1.19.34

func (s *Configuration) SetName(v string) *Configuration

SetName sets the Name field's value.

func (*Configuration) SetState added in v1.34.10

func (s *Configuration) SetState(v string) *Configuration

SetState sets the State field's value.

func (Configuration) String added in v1.19.34

func (s Configuration) String() string

String returns the string representation

type ConfigurationInfo added in v1.19.34

type ConfigurationInfo struct {

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

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

Specifies the configuration to use for the brokers.

func (ConfigurationInfo) GoString added in v1.19.34

func (s ConfigurationInfo) GoString() string

GoString returns the string representation

func (*ConfigurationInfo) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (*ConfigurationInfo) SetRevision added in v1.19.34

func (s *ConfigurationInfo) SetRevision(v int64) *ConfigurationInfo

SetRevision sets the Revision field's value.

func (ConfigurationInfo) String added in v1.19.34

func (s ConfigurationInfo) String() string

String returns the string representation

func (*ConfigurationInfo) Validate added in v1.19.34

func (s *ConfigurationInfo) Validate() error

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

type ConfigurationRevision added in v1.19.34

type ConfigurationRevision struct {

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

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

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

Describes a configuration revision.

func (ConfigurationRevision) GoString added in v1.19.34

func (s ConfigurationRevision) GoString() string

GoString returns the string representation

func (*ConfigurationRevision) SetCreationTime added in v1.19.34

func (s *ConfigurationRevision) SetCreationTime(v time.Time) *ConfigurationRevision

SetCreationTime sets the CreationTime field's value.

func (*ConfigurationRevision) SetDescription added in v1.19.34

func (s *ConfigurationRevision) SetDescription(v string) *ConfigurationRevision

SetDescription sets the Description field's value.

func (*ConfigurationRevision) SetRevision added in v1.19.34

SetRevision sets the Revision field's value.

func (ConfigurationRevision) String added in v1.19.34

func (s ConfigurationRevision) String() string

String returns the string representation

type ConflictException added in v1.28.0

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ConflictException) Code added in v1.28.0

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message added in v1.28.0

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0

func (s ConflictException) String() string

String returns the string representation

type CreateClusterInput

type CreateClusterInput struct {

	// Information about the brokers.
	//
	// BrokerNodeGroupInfo is a required field
	BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" type:"structure" required:"true"`

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

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

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

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

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

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

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

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

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

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

Creates a cluster.

func (CreateClusterInput) GoString

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (*CreateClusterInput) SetBrokerNodeGroupInfo

func (s *CreateClusterInput) SetBrokerNodeGroupInfo(v *BrokerNodeGroupInfo) *CreateClusterInput

SetBrokerNodeGroupInfo sets the BrokerNodeGroupInfo field's value.

func (*CreateClusterInput) SetClientAuthentication added in v1.19.41

func (s *CreateClusterInput) SetClientAuthentication(v *ClientAuthentication) *CreateClusterInput

SetClientAuthentication sets the ClientAuthentication field's value.

func (*CreateClusterInput) SetClusterName

func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput

SetClusterName sets the ClusterName field's value.

func (*CreateClusterInput) SetConfigurationInfo added in v1.19.34

func (s *CreateClusterInput) SetConfigurationInfo(v *ConfigurationInfo) *CreateClusterInput

SetConfigurationInfo sets the ConfigurationInfo field's value.

func (*CreateClusterInput) SetEncryptionInfo

func (s *CreateClusterInput) SetEncryptionInfo(v *EncryptionInfo) *CreateClusterInput

SetEncryptionInfo sets the EncryptionInfo field's value.

func (*CreateClusterInput) SetEnhancedMonitoring

func (s *CreateClusterInput) SetEnhancedMonitoring(v string) *CreateClusterInput

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*CreateClusterInput) SetKafkaVersion

func (s *CreateClusterInput) SetKafkaVersion(v string) *CreateClusterInput

SetKafkaVersion sets the KafkaVersion field's value.

func (*CreateClusterInput) SetLoggingInfo added in v1.29.10

func (s *CreateClusterInput) SetLoggingInfo(v *LoggingInfo) *CreateClusterInput

SetLoggingInfo sets the LoggingInfo field's value.

func (*CreateClusterInput) SetNumberOfBrokerNodes

func (s *CreateClusterInput) SetNumberOfBrokerNodes(v int64) *CreateClusterInput

SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value.

func (*CreateClusterInput) SetOpenMonitoring added in v1.25.49

func (s *CreateClusterInput) SetOpenMonitoring(v *OpenMonitoringInfo) *CreateClusterInput

SetOpenMonitoring sets the OpenMonitoring field's value.

func (*CreateClusterInput) SetTags added in v1.19.41

func (s *CreateClusterInput) SetTags(v map[string]*string) *CreateClusterInput

SetTags sets the Tags field's value.

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 ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State *string `locationName:"state" type:"string" enum:"ClusterState"`
	// contains filtered or unexported fields
}

Returns information about the created cluster.

func (CreateClusterOutput) GoString

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (*CreateClusterOutput) SetClusterArn

func (s *CreateClusterOutput) SetClusterArn(v string) *CreateClusterOutput

SetClusterArn sets the ClusterArn field's value.

func (*CreateClusterOutput) SetClusterName

func (s *CreateClusterOutput) SetClusterName(v string) *CreateClusterOutput

SetClusterName sets the ClusterName field's value.

func (*CreateClusterOutput) SetState

SetState sets the State field's value.

func (CreateClusterOutput) String

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateConfigurationInput added in v1.19.34

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 []*string `locationName:"kafkaVersions" type:"list"`

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

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

Request body for CreateConfiguration.

func (CreateConfigurationInput) GoString added in v1.19.34

func (s CreateConfigurationInput) GoString() string

GoString returns the string representation

func (*CreateConfigurationInput) SetDescription added in v1.19.34

SetDescription sets the Description field's value.

func (*CreateConfigurationInput) SetKafkaVersions added in v1.19.34

func (s *CreateConfigurationInput) SetKafkaVersions(v []*string) *CreateConfigurationInput

SetKafkaVersions sets the KafkaVersions field's value.

func (*CreateConfigurationInput) SetName added in v1.19.34

SetName sets the Name field's value.

func (*CreateConfigurationInput) SetServerProperties added in v1.19.34

func (s *CreateConfigurationInput) SetServerProperties(v []byte) *CreateConfigurationInput

SetServerProperties sets the ServerProperties field's value.

func (CreateConfigurationInput) String added in v1.19.34

func (s CreateConfigurationInput) String() string

String returns the string representation

func (*CreateConfigurationInput) Validate added in v1.19.34

func (s *CreateConfigurationInput) Validate() error

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

type CreateConfigurationOutput added in v1.19.34

type CreateConfigurationOutput struct {

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

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

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

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

	// The state of the configuration. The possible states are ACTIVE, DELETING
	// and DELETE_FAILED.
	State *string `locationName:"state" type:"string" enum:"ConfigurationState"`
	// contains filtered or unexported fields
}

Response body for CreateConfiguration

func (CreateConfigurationOutput) GoString added in v1.19.34

func (s CreateConfigurationOutput) GoString() string

GoString returns the string representation

func (*CreateConfigurationOutput) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (*CreateConfigurationOutput) SetCreationTime added in v1.19.34

SetCreationTime sets the CreationTime field's value.

func (*CreateConfigurationOutput) SetLatestRevision added in v1.19.34

SetLatestRevision sets the LatestRevision field's value.

func (*CreateConfigurationOutput) SetName added in v1.19.34

SetName sets the Name field's value.

func (*CreateConfigurationOutput) SetState added in v1.34.10

SetState sets the State field's value.

func (CreateConfigurationOutput) String added in v1.19.34

func (s CreateConfigurationOutput) String() string

String returns the string representation

type DeleteClusterInput

type DeleteClusterInput struct {

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

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

func (DeleteClusterInput) GoString

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (*DeleteClusterInput) SetClusterArn

func (s *DeleteClusterInput) SetClusterArn(v string) *DeleteClusterInput

SetClusterArn sets the ClusterArn field's value.

func (*DeleteClusterInput) SetCurrentVersion

func (s *DeleteClusterInput) SetCurrentVersion(v string) *DeleteClusterInput

SetCurrentVersion sets the CurrentVersion field's value.

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 ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State *string `locationName:"state" type:"string" enum:"ClusterState"`
	// contains filtered or unexported fields
}

Returns information about the deleted cluster.

func (DeleteClusterOutput) GoString

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteClusterOutput) SetClusterArn

func (s *DeleteClusterOutput) SetClusterArn(v string) *DeleteClusterOutput

SetClusterArn sets the ClusterArn field's value.

func (*DeleteClusterOutput) SetState

SetState sets the State field's value.

func (DeleteClusterOutput) String

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteConfigurationInput added in v1.34.10

type DeleteConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the configuration.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request body for DeleteConfiguration.

func (DeleteConfigurationInput) GoString added in v1.34.10

func (s DeleteConfigurationInput) GoString() string

GoString returns the string representation

func (*DeleteConfigurationInput) SetArn added in v1.34.10

SetArn sets the Arn field's value.

func (DeleteConfigurationInput) String added in v1.34.10

func (s DeleteConfigurationInput) String() string

String returns the string representation

func (*DeleteConfigurationInput) Validate added in v1.34.10

func (s *DeleteConfigurationInput) Validate() error

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

type DeleteConfigurationOutput added in v1.34.10

type DeleteConfigurationOutput struct {

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

	// The state of the configuration. The possible states are ACTIVE, DELETING
	// and DELETE_FAILED.
	State *string `locationName:"state" type:"string" enum:"ConfigurationState"`
	// contains filtered or unexported fields
}

Response body for DeleteConfiguration.

func (DeleteConfigurationOutput) GoString added in v1.34.10

func (s DeleteConfigurationOutput) GoString() string

GoString returns the string representation

func (*DeleteConfigurationOutput) SetArn added in v1.34.10

SetArn sets the Arn field's value.

func (*DeleteConfigurationOutput) SetState added in v1.34.10

SetState sets the State field's value.

func (DeleteConfigurationOutput) String added in v1.34.10

func (s DeleteConfigurationOutput) String() string

String returns the string representation

type DescribeClusterInput

type DescribeClusterInput struct {

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

func (DescribeClusterInput) GoString

func (s DescribeClusterInput) GoString() string

GoString returns the string representation

func (*DescribeClusterInput) SetClusterArn

func (s *DescribeClusterInput) SetClusterArn(v string) *DescribeClusterInput

SetClusterArn sets the ClusterArn field's value.

func (DescribeClusterInput) String

func (s DescribeClusterInput) String() string

String returns the string representation

func (*DescribeClusterInput) Validate

func (s *DescribeClusterInput) Validate() error

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

type DescribeClusterOperationInput added in v1.19.41

type DescribeClusterOperationInput struct {

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

func (DescribeClusterOperationInput) GoString added in v1.19.41

GoString returns the string representation

func (*DescribeClusterOperationInput) SetClusterOperationArn added in v1.19.41

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (DescribeClusterOperationInput) String added in v1.19.41

String returns the string representation

func (*DescribeClusterOperationInput) Validate added in v1.19.41

func (s *DescribeClusterOperationInput) Validate() error

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

type DescribeClusterOperationOutput added in v1.19.41

type DescribeClusterOperationOutput struct {

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

Information about a cluster operation.

func (DescribeClusterOperationOutput) GoString added in v1.19.41

GoString returns the string representation

func (*DescribeClusterOperationOutput) SetClusterOperationInfo added in v1.19.41

SetClusterOperationInfo sets the ClusterOperationInfo field's value.

func (DescribeClusterOperationOutput) String added in v1.19.41

String returns the string representation

type DescribeClusterOutput

type DescribeClusterOutput struct {

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

Returns information about a cluster.

func (DescribeClusterOutput) GoString

func (s DescribeClusterOutput) GoString() string

GoString returns the string representation

func (*DescribeClusterOutput) SetClusterInfo

SetClusterInfo sets the ClusterInfo field's value.

func (DescribeClusterOutput) String

func (s DescribeClusterOutput) String() string

String returns the string representation

type DescribeConfigurationInput added in v1.19.34

type DescribeConfigurationInput struct {

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

func (DescribeConfigurationInput) GoString added in v1.19.34

func (s DescribeConfigurationInput) GoString() string

GoString returns the string representation

func (*DescribeConfigurationInput) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (DescribeConfigurationInput) String added in v1.19.34

String returns the string representation

func (*DescribeConfigurationInput) Validate added in v1.19.34

func (s *DescribeConfigurationInput) Validate() error

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

type DescribeConfigurationOutput added in v1.19.34

type DescribeConfigurationOutput struct {

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

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

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

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

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

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

	// The state of the configuration. The possible states are ACTIVE, DELETING
	// and DELETE_FAILED.
	State *string `locationName:"state" type:"string" enum:"ConfigurationState"`
	// contains filtered or unexported fields
}

Response body for DescribeConfiguration.

func (DescribeConfigurationOutput) GoString added in v1.19.34

func (s DescribeConfigurationOutput) GoString() string

GoString returns the string representation

func (*DescribeConfigurationOutput) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (*DescribeConfigurationOutput) SetCreationTime added in v1.19.34

SetCreationTime sets the CreationTime field's value.

func (*DescribeConfigurationOutput) SetDescription added in v1.19.34

SetDescription sets the Description field's value.

func (*DescribeConfigurationOutput) SetKafkaVersions added in v1.19.34

SetKafkaVersions sets the KafkaVersions field's value.

func (*DescribeConfigurationOutput) SetLatestRevision added in v1.19.34

SetLatestRevision sets the LatestRevision field's value.

func (*DescribeConfigurationOutput) SetName added in v1.19.34

SetName sets the Name field's value.

func (*DescribeConfigurationOutput) SetState added in v1.34.10

SetState sets the State field's value.

func (DescribeConfigurationOutput) String added in v1.19.34

String returns the string representation

type DescribeConfigurationRevisionInput added in v1.19.34

type DescribeConfigurationRevisionInput struct {

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

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

func (DescribeConfigurationRevisionInput) GoString added in v1.19.34

GoString returns the string representation

func (*DescribeConfigurationRevisionInput) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (*DescribeConfigurationRevisionInput) SetRevision added in v1.19.34

SetRevision sets the Revision field's value.

func (DescribeConfigurationRevisionInput) String added in v1.19.34

String returns the string representation

func (*DescribeConfigurationRevisionInput) Validate added in v1.19.34

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

type DescribeConfigurationRevisionOutput added in v1.19.34

type DescribeConfigurationRevisionOutput struct {

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

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

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

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

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

Response body for DescribeConfigurationRevision.

func (DescribeConfigurationRevisionOutput) GoString added in v1.19.34

GoString returns the string representation

func (*DescribeConfigurationRevisionOutput) SetArn added in v1.19.34

SetArn sets the Arn field's value.

func (*DescribeConfigurationRevisionOutput) SetCreationTime added in v1.19.34

SetCreationTime sets the CreationTime field's value.

func (*DescribeConfigurationRevisionOutput) SetDescription added in v1.19.34

SetDescription sets the Description field's value.

func (*DescribeConfigurationRevisionOutput) SetRevision added in v1.19.34

SetRevision sets the Revision field's value.

func (*DescribeConfigurationRevisionOutput) SetServerProperties added in v1.19.34

SetServerProperties sets the ServerProperties field's value.

func (DescribeConfigurationRevisionOutput) String added in v1.19.34

String returns the string representation

type EBSStorageInfo

type EBSStorageInfo struct {

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

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

func (EBSStorageInfo) GoString

func (s EBSStorageInfo) GoString() string

GoString returns the string representation

func (*EBSStorageInfo) SetVolumeSize

func (s *EBSStorageInfo) SetVolumeSize(v int64) *EBSStorageInfo

SetVolumeSize sets the VolumeSize field's value.

func (EBSStorageInfo) String

func (s EBSStorageInfo) String() string

String returns the string representation

func (*EBSStorageInfo) Validate

func (s *EBSStorageInfo) Validate() error

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

type EncryptionAtRest

type EncryptionAtRest struct {

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

The data-volume encryption details.

func (EncryptionAtRest) GoString

func (s EncryptionAtRest) GoString() string

GoString returns the string representation

func (*EncryptionAtRest) SetDataVolumeKMSKeyId

func (s *EncryptionAtRest) SetDataVolumeKMSKeyId(v string) *EncryptionAtRest

SetDataVolumeKMSKeyId sets the DataVolumeKMSKeyId field's value.

func (EncryptionAtRest) String

func (s EncryptionAtRest) String() string

String returns the string representation

func (*EncryptionAtRest) Validate

func (s *EncryptionAtRest) Validate() error

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

type EncryptionInTransit added in v1.19.41

type EncryptionInTransit struct {

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

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

The settings for encrypting data in transit.

func (EncryptionInTransit) GoString added in v1.19.41

func (s EncryptionInTransit) GoString() string

GoString returns the string representation

func (*EncryptionInTransit) SetClientBroker added in v1.19.41

func (s *EncryptionInTransit) SetClientBroker(v string) *EncryptionInTransit

SetClientBroker sets the ClientBroker field's value.

func (*EncryptionInTransit) SetInCluster added in v1.19.41

func (s *EncryptionInTransit) SetInCluster(v bool) *EncryptionInTransit

SetInCluster sets the InCluster field's value.

func (EncryptionInTransit) String added in v1.19.41

func (s EncryptionInTransit) String() string

String returns the string representation

type EncryptionInfo

type EncryptionInfo struct {

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

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

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

func (EncryptionInfo) GoString

func (s EncryptionInfo) GoString() string

GoString returns the string representation

func (*EncryptionInfo) SetEncryptionAtRest

func (s *EncryptionInfo) SetEncryptionAtRest(v *EncryptionAtRest) *EncryptionInfo

SetEncryptionAtRest sets the EncryptionAtRest field's value.

func (*EncryptionInfo) SetEncryptionInTransit added in v1.19.41

func (s *EncryptionInfo) SetEncryptionInTransit(v *EncryptionInTransit) *EncryptionInfo

SetEncryptionInTransit sets the EncryptionInTransit field's value.

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 ErrorInfo added in v1.19.41

type ErrorInfo struct {

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

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

Returns information about an error state of the cluster.

func (ErrorInfo) GoString added in v1.19.41

func (s ErrorInfo) GoString() string

GoString returns the string representation

func (*ErrorInfo) SetErrorCode added in v1.19.41

func (s *ErrorInfo) SetErrorCode(v string) *ErrorInfo

SetErrorCode sets the ErrorCode field's value.

func (*ErrorInfo) SetErrorString added in v1.19.41

func (s *ErrorInfo) SetErrorString(v string) *ErrorInfo

SetErrorString sets the ErrorString field's value.

func (ErrorInfo) String added in v1.19.41

func (s ErrorInfo) String() string

String returns the string representation

type Firehose added in v1.29.10

type Firehose struct {

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

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

Firehose details for BrokerLogs.

func (Firehose) GoString added in v1.29.10

func (s Firehose) GoString() string

GoString returns the string representation

func (*Firehose) SetDeliveryStream added in v1.29.10

func (s *Firehose) SetDeliveryStream(v string) *Firehose

SetDeliveryStream sets the DeliveryStream field's value.

func (*Firehose) SetEnabled added in v1.29.10

func (s *Firehose) SetEnabled(v bool) *Firehose

SetEnabled sets the Enabled field's value.

func (Firehose) String added in v1.29.10

func (s Firehose) String() string

String returns the string representation

func (*Firehose) Validate added in v1.29.10

func (s *Firehose) Validate() error

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

type ForbiddenException added in v1.28.0

type ForbiddenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ForbiddenException) Code added in v1.28.0

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error added in v1.28.0

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString added in v1.28.0

func (s ForbiddenException) GoString() string

GoString returns the string representation

func (*ForbiddenException) Message added in v1.28.0

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr added in v1.28.0

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID added in v1.28.0

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode added in v1.28.0

func (s *ForbiddenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ForbiddenException) String added in v1.28.0

func (s ForbiddenException) String() string

String returns the string representation

type GetBootstrapBrokersInput

type GetBootstrapBrokersInput struct {

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

func (GetBootstrapBrokersInput) GoString

func (s GetBootstrapBrokersInput) GoString() string

GoString returns the string representation

func (*GetBootstrapBrokersInput) SetClusterArn

SetClusterArn sets the ClusterArn field's value.

func (GetBootstrapBrokersInput) String

func (s GetBootstrapBrokersInput) String() string

String returns the string representation

func (*GetBootstrapBrokersInput) Validate

func (s *GetBootstrapBrokersInput) Validate() error

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

type GetBootstrapBrokersOutput

type GetBootstrapBrokersOutput struct {

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

	// A string containing one or more DNS names (or IP) and SASL SCRAM port pairs.
	// The following is an example.
	//  { "BootstrapBrokerStringSaslScram": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096"}
	BootstrapBrokerStringSaslScram *string `locationName:"bootstrapBrokerStringSaslScram" type:"string"`

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

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

func (GetBootstrapBrokersOutput) GoString

func (s GetBootstrapBrokersOutput) GoString() string

GoString returns the string representation

func (*GetBootstrapBrokersOutput) SetBootstrapBrokerString

func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerString(v string) *GetBootstrapBrokersOutput

SetBootstrapBrokerString sets the BootstrapBrokerString field's value.

func (*GetBootstrapBrokersOutput) SetBootstrapBrokerStringSaslScram added in v1.34.24

func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringSaslScram(v string) *GetBootstrapBrokersOutput

SetBootstrapBrokerStringSaslScram sets the BootstrapBrokerStringSaslScram field's value.

func (*GetBootstrapBrokersOutput) SetBootstrapBrokerStringTls added in v1.19.41

func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringTls(v string) *GetBootstrapBrokersOutput

SetBootstrapBrokerStringTls sets the BootstrapBrokerStringTls field's value.

func (GetBootstrapBrokersOutput) String

func (s GetBootstrapBrokersOutput) String() string

String returns the string representation

type GetCompatibleKafkaVersionsInput added in v1.31.7

type GetCompatibleKafkaVersionsInput struct {
	ClusterArn *string `location:"querystring" locationName:"clusterArn" type:"string"`
	// contains filtered or unexported fields
}

func (GetCompatibleKafkaVersionsInput) GoString added in v1.31.7

GoString returns the string representation

func (*GetCompatibleKafkaVersionsInput) SetClusterArn added in v1.31.7

SetClusterArn sets the ClusterArn field's value.

func (GetCompatibleKafkaVersionsInput) String added in v1.31.7

String returns the string representation

type GetCompatibleKafkaVersionsOutput added in v1.31.7

type GetCompatibleKafkaVersionsOutput struct {

	// A list of CompatibleKafkaVersion objects.
	CompatibleKafkaVersions []*CompatibleKafkaVersion `locationName:"compatibleKafkaVersions" type:"list"`
	// contains filtered or unexported fields
}

Response body for GetCompatibleKafkaVersions.

func (GetCompatibleKafkaVersionsOutput) GoString added in v1.31.7

GoString returns the string representation

func (*GetCompatibleKafkaVersionsOutput) SetCompatibleKafkaVersions added in v1.31.7

SetCompatibleKafkaVersions sets the CompatibleKafkaVersions field's value.

func (GetCompatibleKafkaVersionsOutput) String added in v1.31.7

String returns the string representation

type InternalServerErrorException added in v1.28.0

type InternalServerErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*InternalServerErrorException) Code added in v1.28.0

Code returns the exception type name.

func (*InternalServerErrorException) Error added in v1.28.0

func (InternalServerErrorException) GoString added in v1.28.0

func (s InternalServerErrorException) GoString() string

GoString returns the string representation

func (*InternalServerErrorException) Message added in v1.28.0

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr added in v1.28.0

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID added in v1.28.0

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode added in v1.28.0

func (s *InternalServerErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerErrorException) String added in v1.28.0

String returns the string representation

type JmxExporter added in v1.25.49

type JmxExporter struct {

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

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

func (JmxExporter) GoString added in v1.25.49

func (s JmxExporter) GoString() string

GoString returns the string representation

func (*JmxExporter) SetEnabledInBroker added in v1.25.49

func (s *JmxExporter) SetEnabledInBroker(v bool) *JmxExporter

SetEnabledInBroker sets the EnabledInBroker field's value.

func (JmxExporter) String added in v1.25.49

func (s JmxExporter) String() string

String returns the string representation

type JmxExporterInfo added in v1.25.49

type JmxExporterInfo struct {

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

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

func (JmxExporterInfo) GoString added in v1.25.49

func (s JmxExporterInfo) GoString() string

GoString returns the string representation

func (*JmxExporterInfo) SetEnabledInBroker added in v1.25.49

func (s *JmxExporterInfo) SetEnabledInBroker(v bool) *JmxExporterInfo

SetEnabledInBroker sets the EnabledInBroker field's value.

func (JmxExporterInfo) String added in v1.25.49

func (s JmxExporterInfo) String() string

String returns the string representation

func (*JmxExporterInfo) Validate added in v1.25.49

func (s *JmxExporterInfo) Validate() error

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

type Kafka

type Kafka struct {
	*client.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(p client.ConfigProvider, cfgs ...*aws.Config) *Kafka

New creates a new instance of the Kafka client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Kafka client from just a session.
svc := kafka.New(mySession)

// Create a Kafka client with additional configuration
svc := kafka.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Kafka) BatchAssociateScramSecret added in v1.34.24

func (c *Kafka) BatchAssociateScramSecret(input *BatchAssociateScramSecretInput) (*BatchAssociateScramSecretOutput, error)

BatchAssociateScramSecret API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation BatchAssociateScramSecret for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BatchAssociateScramSecret

func (*Kafka) BatchAssociateScramSecretRequest added in v1.34.24

func (c *Kafka) BatchAssociateScramSecretRequest(input *BatchAssociateScramSecretInput) (req *request.Request, output *BatchAssociateScramSecretOutput)

BatchAssociateScramSecretRequest generates a "aws/request.Request" representing the client's request for the BatchAssociateScramSecret operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchAssociateScramSecret for more information on using the BatchAssociateScramSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchAssociateScramSecretRequest method.
req, resp := client.BatchAssociateScramSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BatchAssociateScramSecret

func (*Kafka) BatchAssociateScramSecretWithContext added in v1.34.24

func (c *Kafka) BatchAssociateScramSecretWithContext(ctx aws.Context, input *BatchAssociateScramSecretInput, opts ...request.Option) (*BatchAssociateScramSecretOutput, error)

BatchAssociateScramSecretWithContext is the same as BatchAssociateScramSecret with the addition of the ability to pass a context and additional request options.

See BatchAssociateScramSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) BatchDisassociateScramSecret added in v1.34.24

func (c *Kafka) BatchDisassociateScramSecret(input *BatchDisassociateScramSecretInput) (*BatchDisassociateScramSecretOutput, error)

BatchDisassociateScramSecret API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation BatchDisassociateScramSecret for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BatchDisassociateScramSecret

func (*Kafka) BatchDisassociateScramSecretRequest added in v1.34.24

func (c *Kafka) BatchDisassociateScramSecretRequest(input *BatchDisassociateScramSecretInput) (req *request.Request, output *BatchDisassociateScramSecretOutput)

BatchDisassociateScramSecretRequest generates a "aws/request.Request" representing the client's request for the BatchDisassociateScramSecret operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDisassociateScramSecret for more information on using the BatchDisassociateScramSecret API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDisassociateScramSecretRequest method.
req, resp := client.BatchDisassociateScramSecretRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/BatchDisassociateScramSecret

func (*Kafka) BatchDisassociateScramSecretWithContext added in v1.34.24

func (c *Kafka) BatchDisassociateScramSecretWithContext(ctx aws.Context, input *BatchDisassociateScramSecretInput, opts ...request.Option) (*BatchDisassociateScramSecretOutput, error)

BatchDisassociateScramSecretWithContext is the same as BatchDisassociateScramSecret with the addition of the ability to pass a context and additional request options.

See BatchDisassociateScramSecret for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) CreateCluster

func (c *Kafka) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster API operation for Managed Streaming for Kafka.

Creates a new MSK cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation CreateCluster for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

  • ConflictException Returns information about an error.

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

func (*Kafka) CreateClusterRequest

func (c *Kafka) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) CreateClusterWithContext

func (c *Kafka) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) CreateConfiguration added in v1.19.34

func (c *Kafka) CreateConfiguration(input *CreateConfigurationInput) (*CreateConfigurationOutput, error)

CreateConfiguration API operation for Managed Streaming for Kafka.

Creates a new MSK configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation CreateConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

  • ConflictException Returns information about an error.

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

func (*Kafka) CreateConfigurationRequest added in v1.19.34

func (c *Kafka) CreateConfigurationRequest(input *CreateConfigurationInput) (req *request.Request, output *CreateConfigurationOutput)

CreateConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfiguration for more information on using the CreateConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfigurationRequest method.
req, resp := client.CreateConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) CreateConfigurationWithContext added in v1.19.34

func (c *Kafka) CreateConfigurationWithContext(ctx aws.Context, input *CreateConfigurationInput, opts ...request.Option) (*CreateConfigurationOutput, error)

CreateConfigurationWithContext is the same as CreateConfiguration with the addition of the ability to pass a context and additional request options.

See CreateConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DeleteCluster

func (c *Kafka) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

DeleteCluster API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DeleteCluster for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) DeleteClusterRequest

func (c *Kafka) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) DeleteClusterWithContext

func (c *Kafka) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DeleteConfiguration added in v1.34.10

func (c *Kafka) DeleteConfiguration(input *DeleteConfigurationInput) (*DeleteConfigurationOutput, error)

DeleteConfiguration API operation for Managed Streaming for Kafka.

Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DeleteConfiguration for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DeleteConfiguration

func (*Kafka) DeleteConfigurationRequest added in v1.34.10

func (c *Kafka) DeleteConfigurationRequest(input *DeleteConfigurationInput) (req *request.Request, output *DeleteConfigurationOutput)

DeleteConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfiguration for more information on using the DeleteConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfigurationRequest method.
req, resp := client.DeleteConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DeleteConfiguration

func (*Kafka) DeleteConfigurationWithContext added in v1.34.10

func (c *Kafka) DeleteConfigurationWithContext(ctx aws.Context, input *DeleteConfigurationInput, opts ...request.Option) (*DeleteConfigurationOutput, error)

DeleteConfigurationWithContext is the same as DeleteConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DescribeCluster

func (c *Kafka) DescribeCluster(input *DescribeClusterInput) (*DescribeClusterOutput, error)

DescribeCluster API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DescribeCluster for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) DescribeClusterOperation added in v1.19.41

func (c *Kafka) DescribeClusterOperation(input *DescribeClusterOperationInput) (*DescribeClusterOperationOutput, error)

DescribeClusterOperation API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DescribeClusterOperation for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) DescribeClusterOperationRequest added in v1.19.41

func (c *Kafka) DescribeClusterOperationRequest(input *DescribeClusterOperationInput) (req *request.Request, output *DescribeClusterOperationOutput)

DescribeClusterOperationRequest generates a "aws/request.Request" representing the client's request for the DescribeClusterOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClusterOperation for more information on using the DescribeClusterOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeClusterOperationRequest method.
req, resp := client.DescribeClusterOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) DescribeClusterOperationWithContext added in v1.19.41

func (c *Kafka) DescribeClusterOperationWithContext(ctx aws.Context, input *DescribeClusterOperationInput, opts ...request.Option) (*DescribeClusterOperationOutput, error)

DescribeClusterOperationWithContext is the same as DescribeClusterOperation with the addition of the ability to pass a context and additional request options.

See DescribeClusterOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DescribeClusterRequest

func (c *Kafka) DescribeClusterRequest(input *DescribeClusterInput) (req *request.Request, output *DescribeClusterOutput)

DescribeClusterRequest generates a "aws/request.Request" representing the client's request for the DescribeCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCluster for more information on using the DescribeCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeClusterRequest method.
req, resp := client.DescribeClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) DescribeClusterWithContext

func (c *Kafka) DescribeClusterWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.Option) (*DescribeClusterOutput, error)

DescribeClusterWithContext is the same as DescribeCluster with the addition of the ability to pass a context and additional request options.

See DescribeCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DescribeConfiguration added in v1.19.34

func (c *Kafka) DescribeConfiguration(input *DescribeConfigurationInput) (*DescribeConfigurationOutput, error)

DescribeConfiguration API operation for Managed Streaming for Kafka.

Returns a description of this MSK configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DescribeConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

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

func (*Kafka) DescribeConfigurationRequest added in v1.19.34

func (c *Kafka) DescribeConfigurationRequest(input *DescribeConfigurationInput) (req *request.Request, output *DescribeConfigurationOutput)

DescribeConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConfiguration for more information on using the DescribeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConfigurationRequest method.
req, resp := client.DescribeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) DescribeConfigurationRevision added in v1.19.34

func (c *Kafka) DescribeConfigurationRevision(input *DescribeConfigurationRevisionInput) (*DescribeConfigurationRevisionOutput, error)

DescribeConfigurationRevision API operation for Managed Streaming for Kafka.

Returns a description of this revision of the configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation DescribeConfigurationRevision for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

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

func (*Kafka) DescribeConfigurationRevisionRequest added in v1.19.34

func (c *Kafka) DescribeConfigurationRevisionRequest(input *DescribeConfigurationRevisionInput) (req *request.Request, output *DescribeConfigurationRevisionOutput)

DescribeConfigurationRevisionRequest generates a "aws/request.Request" representing the client's request for the DescribeConfigurationRevision operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConfigurationRevision for more information on using the DescribeConfigurationRevision API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConfigurationRevisionRequest method.
req, resp := client.DescribeConfigurationRevisionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) DescribeConfigurationRevisionWithContext added in v1.19.34

func (c *Kafka) DescribeConfigurationRevisionWithContext(ctx aws.Context, input *DescribeConfigurationRevisionInput, opts ...request.Option) (*DescribeConfigurationRevisionOutput, error)

DescribeConfigurationRevisionWithContext is the same as DescribeConfigurationRevision with the addition of the ability to pass a context and additional request options.

See DescribeConfigurationRevision for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) DescribeConfigurationWithContext added in v1.19.34

func (c *Kafka) DescribeConfigurationWithContext(ctx aws.Context, input *DescribeConfigurationInput, opts ...request.Option) (*DescribeConfigurationOutput, error)

DescribeConfigurationWithContext is the same as DescribeConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) GetBootstrapBrokers

func (c *Kafka) GetBootstrapBrokers(input *GetBootstrapBrokersInput) (*GetBootstrapBrokersOutput, error)

GetBootstrapBrokers API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation GetBootstrapBrokers for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) GetBootstrapBrokersRequest

func (c *Kafka) GetBootstrapBrokersRequest(input *GetBootstrapBrokersInput) (req *request.Request, output *GetBootstrapBrokersOutput)

GetBootstrapBrokersRequest generates a "aws/request.Request" representing the client's request for the GetBootstrapBrokers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBootstrapBrokers for more information on using the GetBootstrapBrokers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBootstrapBrokersRequest method.
req, resp := client.GetBootstrapBrokersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) GetBootstrapBrokersWithContext

func (c *Kafka) GetBootstrapBrokersWithContext(ctx aws.Context, input *GetBootstrapBrokersInput, opts ...request.Option) (*GetBootstrapBrokersOutput, error)

GetBootstrapBrokersWithContext is the same as GetBootstrapBrokers with the addition of the ability to pass a context and additional request options.

See GetBootstrapBrokers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) GetCompatibleKafkaVersions added in v1.31.7

func (c *Kafka) GetCompatibleKafkaVersions(input *GetCompatibleKafkaVersionsInput) (*GetCompatibleKafkaVersionsOutput, error)

GetCompatibleKafkaVersions API operation for Managed Streaming for Kafka.

Gets the Apache Kafka versions to which you can update the MSK cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation GetCompatibleKafkaVersions for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetCompatibleKafkaVersions

func (*Kafka) GetCompatibleKafkaVersionsRequest added in v1.31.7

func (c *Kafka) GetCompatibleKafkaVersionsRequest(input *GetCompatibleKafkaVersionsInput) (req *request.Request, output *GetCompatibleKafkaVersionsOutput)

GetCompatibleKafkaVersionsRequest generates a "aws/request.Request" representing the client's request for the GetCompatibleKafkaVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCompatibleKafkaVersions for more information on using the GetCompatibleKafkaVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCompatibleKafkaVersionsRequest method.
req, resp := client.GetCompatibleKafkaVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetCompatibleKafkaVersions

func (*Kafka) GetCompatibleKafkaVersionsWithContext added in v1.31.7

func (c *Kafka) GetCompatibleKafkaVersionsWithContext(ctx aws.Context, input *GetCompatibleKafkaVersionsInput, opts ...request.Option) (*GetCompatibleKafkaVersionsOutput, error)

GetCompatibleKafkaVersionsWithContext is the same as GetCompatibleKafkaVersions with the addition of the ability to pass a context and additional request options.

See GetCompatibleKafkaVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListClusterOperations added in v1.19.41

func (c *Kafka) ListClusterOperations(input *ListClusterOperationsInput) (*ListClusterOperationsOutput, error)

ListClusterOperations API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListClusterOperations for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) ListClusterOperationsPages added in v1.19.41

func (c *Kafka) ListClusterOperationsPages(input *ListClusterOperationsInput, fn func(*ListClusterOperationsOutput, bool) bool) error

ListClusterOperationsPages iterates over the pages of a ListClusterOperations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusterOperations method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListClusterOperations operation.
pageNum := 0
err := client.ListClusterOperationsPages(params,
    func(page *kafka.ListClusterOperationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListClusterOperationsPagesWithContext added in v1.19.41

func (c *Kafka) ListClusterOperationsPagesWithContext(ctx aws.Context, input *ListClusterOperationsInput, fn func(*ListClusterOperationsOutput, bool) bool, opts ...request.Option) error

ListClusterOperationsPagesWithContext same as ListClusterOperationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListClusterOperationsRequest added in v1.19.41

func (c *Kafka) ListClusterOperationsRequest(input *ListClusterOperationsInput) (req *request.Request, output *ListClusterOperationsOutput)

ListClusterOperationsRequest generates a "aws/request.Request" representing the client's request for the ListClusterOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusterOperations for more information on using the ListClusterOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListClusterOperationsRequest method.
req, resp := client.ListClusterOperationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListClusterOperationsWithContext added in v1.19.41

func (c *Kafka) ListClusterOperationsWithContext(ctx aws.Context, input *ListClusterOperationsInput, opts ...request.Option) (*ListClusterOperationsOutput, error)

ListClusterOperationsWithContext is the same as ListClusterOperations with the addition of the ability to pass a context and additional request options.

See ListClusterOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListClusters

func (c *Kafka) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)

ListClusters API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListClusters for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) ListClustersPages added in v1.19.34

func (c *Kafka) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error

ListClustersPages iterates over the pages of a ListClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusters method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListClusters operation.
pageNum := 0
err := client.ListClustersPages(params,
    func(page *kafka.ListClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListClustersPagesWithContext added in v1.19.34

func (c *Kafka) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error

ListClustersPagesWithContext same as ListClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListClustersRequest

func (c *Kafka) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)

ListClustersRequest generates a "aws/request.Request" representing the client's request for the ListClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusters for more information on using the ListClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListClustersRequest method.
req, resp := client.ListClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListClustersWithContext

func (c *Kafka) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)

ListClustersWithContext is the same as ListClusters with the addition of the ability to pass a context and additional request options.

See ListClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListConfigurationRevisions added in v1.19.41

func (c *Kafka) ListConfigurationRevisions(input *ListConfigurationRevisionsInput) (*ListConfigurationRevisionsOutput, error)

ListConfigurationRevisions API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListConfigurationRevisions for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

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

func (*Kafka) ListConfigurationRevisionsPages added in v1.19.41

func (c *Kafka) ListConfigurationRevisionsPages(input *ListConfigurationRevisionsInput, fn func(*ListConfigurationRevisionsOutput, bool) bool) error

ListConfigurationRevisionsPages iterates over the pages of a ListConfigurationRevisions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfigurationRevisions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListConfigurationRevisions operation.
pageNum := 0
err := client.ListConfigurationRevisionsPages(params,
    func(page *kafka.ListConfigurationRevisionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListConfigurationRevisionsPagesWithContext added in v1.19.41

func (c *Kafka) ListConfigurationRevisionsPagesWithContext(ctx aws.Context, input *ListConfigurationRevisionsInput, fn func(*ListConfigurationRevisionsOutput, bool) bool, opts ...request.Option) error

ListConfigurationRevisionsPagesWithContext same as ListConfigurationRevisionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListConfigurationRevisionsRequest added in v1.19.41

func (c *Kafka) ListConfigurationRevisionsRequest(input *ListConfigurationRevisionsInput) (req *request.Request, output *ListConfigurationRevisionsOutput)

ListConfigurationRevisionsRequest generates a "aws/request.Request" representing the client's request for the ListConfigurationRevisions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConfigurationRevisions for more information on using the ListConfigurationRevisions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListConfigurationRevisionsRequest method.
req, resp := client.ListConfigurationRevisionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListConfigurationRevisionsWithContext added in v1.19.41

func (c *Kafka) ListConfigurationRevisionsWithContext(ctx aws.Context, input *ListConfigurationRevisionsInput, opts ...request.Option) (*ListConfigurationRevisionsOutput, error)

ListConfigurationRevisionsWithContext is the same as ListConfigurationRevisions with the addition of the ability to pass a context and additional request options.

See ListConfigurationRevisions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListConfigurations added in v1.19.34

func (c *Kafka) ListConfigurations(input *ListConfigurationsInput) (*ListConfigurationsOutput, error)

ListConfigurations API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListConfigurations for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) ListConfigurationsPages added in v1.19.34

func (c *Kafka) ListConfigurationsPages(input *ListConfigurationsInput, fn func(*ListConfigurationsOutput, bool) bool) error

ListConfigurationsPages iterates over the pages of a ListConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfigurations method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListConfigurations operation.
pageNum := 0
err := client.ListConfigurationsPages(params,
    func(page *kafka.ListConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListConfigurationsPagesWithContext added in v1.19.34

func (c *Kafka) ListConfigurationsPagesWithContext(ctx aws.Context, input *ListConfigurationsInput, fn func(*ListConfigurationsOutput, bool) bool, opts ...request.Option) error

ListConfigurationsPagesWithContext same as ListConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListConfigurationsRequest added in v1.19.34

func (c *Kafka) ListConfigurationsRequest(input *ListConfigurationsInput) (req *request.Request, output *ListConfigurationsOutput)

ListConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConfigurations for more information on using the ListConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListConfigurationsRequest method.
req, resp := client.ListConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListConfigurationsWithContext added in v1.19.34

func (c *Kafka) ListConfigurationsWithContext(ctx aws.Context, input *ListConfigurationsInput, opts ...request.Option) (*ListConfigurationsOutput, error)

ListConfigurationsWithContext is the same as ListConfigurations with the addition of the ability to pass a context and additional request options.

See ListConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListKafkaVersions added in v1.28.10

func (c *Kafka) ListKafkaVersions(input *ListKafkaVersionsInput) (*ListKafkaVersionsOutput, error)

ListKafkaVersions API operation for Managed Streaming for Kafka.

Returns a list of Kafka versions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListKafkaVersions for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) ListKafkaVersionsPages added in v1.28.10

func (c *Kafka) ListKafkaVersionsPages(input *ListKafkaVersionsInput, fn func(*ListKafkaVersionsOutput, bool) bool) error

ListKafkaVersionsPages iterates over the pages of a ListKafkaVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKafkaVersions method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListKafkaVersions operation.
pageNum := 0
err := client.ListKafkaVersionsPages(params,
    func(page *kafka.ListKafkaVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListKafkaVersionsPagesWithContext added in v1.28.10

func (c *Kafka) ListKafkaVersionsPagesWithContext(ctx aws.Context, input *ListKafkaVersionsInput, fn func(*ListKafkaVersionsOutput, bool) bool, opts ...request.Option) error

ListKafkaVersionsPagesWithContext same as ListKafkaVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListKafkaVersionsRequest added in v1.28.10

func (c *Kafka) ListKafkaVersionsRequest(input *ListKafkaVersionsInput) (req *request.Request, output *ListKafkaVersionsOutput)

ListKafkaVersionsRequest generates a "aws/request.Request" representing the client's request for the ListKafkaVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKafkaVersions for more information on using the ListKafkaVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListKafkaVersionsRequest method.
req, resp := client.ListKafkaVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListKafkaVersionsWithContext added in v1.28.10

func (c *Kafka) ListKafkaVersionsWithContext(ctx aws.Context, input *ListKafkaVersionsInput, opts ...request.Option) (*ListKafkaVersionsOutput, error)

ListKafkaVersionsWithContext is the same as ListKafkaVersions with the addition of the ability to pass a context and additional request options.

See ListKafkaVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListNodes

func (c *Kafka) ListNodes(input *ListNodesInput) (*ListNodesOutput, error)

ListNodes API operation for Managed Streaming for Kafka.

Returns a list of the broker nodes in the cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListNodes for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) ListNodesPages added in v1.19.34

func (c *Kafka) ListNodesPages(input *ListNodesInput, fn func(*ListNodesOutput, bool) bool) error

ListNodesPages iterates over the pages of a ListNodes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNodes method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListNodes operation.
pageNum := 0
err := client.ListNodesPages(params,
    func(page *kafka.ListNodesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListNodesPagesWithContext added in v1.19.34

func (c *Kafka) ListNodesPagesWithContext(ctx aws.Context, input *ListNodesInput, fn func(*ListNodesOutput, bool) bool, opts ...request.Option) error

ListNodesPagesWithContext same as ListNodesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListNodesRequest

func (c *Kafka) ListNodesRequest(input *ListNodesInput) (req *request.Request, output *ListNodesOutput)

ListNodesRequest generates a "aws/request.Request" representing the client's request for the ListNodes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNodes for more information on using the ListNodes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNodesRequest method.
req, resp := client.ListNodesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListNodesWithContext

func (c *Kafka) ListNodesWithContext(ctx aws.Context, input *ListNodesInput, opts ...request.Option) (*ListNodesOutput, error)

ListNodesWithContext is the same as ListNodes with the addition of the ability to pass a context and additional request options.

See ListNodes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListScramSecrets added in v1.34.24

func (c *Kafka) ListScramSecrets(input *ListScramSecretsInput) (*ListScramSecretsOutput, error)

ListScramSecrets API operation for Managed Streaming for Kafka.

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListScramSecrets for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListScramSecrets

func (*Kafka) ListScramSecretsPages added in v1.34.24

func (c *Kafka) ListScramSecretsPages(input *ListScramSecretsInput, fn func(*ListScramSecretsOutput, bool) bool) error

ListScramSecretsPages iterates over the pages of a ListScramSecrets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListScramSecrets method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListScramSecrets operation.
pageNum := 0
err := client.ListScramSecretsPages(params,
    func(page *kafka.ListScramSecretsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kafka) ListScramSecretsPagesWithContext added in v1.34.24

func (c *Kafka) ListScramSecretsPagesWithContext(ctx aws.Context, input *ListScramSecretsInput, fn func(*ListScramSecretsOutput, bool) bool, opts ...request.Option) error

ListScramSecretsPagesWithContext same as ListScramSecretsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListScramSecretsRequest added in v1.34.24

func (c *Kafka) ListScramSecretsRequest(input *ListScramSecretsInput) (req *request.Request, output *ListScramSecretsOutput)

ListScramSecretsRequest generates a "aws/request.Request" representing the client's request for the ListScramSecrets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListScramSecrets for more information on using the ListScramSecrets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListScramSecretsRequest method.
req, resp := client.ListScramSecretsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListScramSecrets

func (*Kafka) ListScramSecretsWithContext added in v1.34.24

func (c *Kafka) ListScramSecretsWithContext(ctx aws.Context, input *ListScramSecretsInput, opts ...request.Option) (*ListScramSecretsOutput, error)

ListScramSecretsWithContext is the same as ListScramSecrets with the addition of the ability to pass a context and additional request options.

See ListScramSecrets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) ListTagsForResource added in v1.19.14

func (c *Kafka) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

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

func (*Kafka) ListTagsForResourceRequest added in v1.19.14

func (c *Kafka) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) ListTagsForResourceWithContext added in v1.19.14

func (c *Kafka) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) RebootBroker added in v1.33.16

func (c *Kafka) RebootBroker(input *RebootBrokerInput) (*RebootBrokerOutput, error)

RebootBroker API operation for Managed Streaming for Kafka.

Executes a reboot on a broker.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation RebootBroker for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/RebootBroker

func (*Kafka) RebootBrokerRequest added in v1.33.16

func (c *Kafka) RebootBrokerRequest(input *RebootBrokerInput) (req *request.Request, output *RebootBrokerOutput)

RebootBrokerRequest generates a "aws/request.Request" representing the client's request for the RebootBroker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootBroker for more information on using the RebootBroker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootBrokerRequest method.
req, resp := client.RebootBrokerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/RebootBroker

func (*Kafka) RebootBrokerWithContext added in v1.33.16

func (c *Kafka) RebootBrokerWithContext(ctx aws.Context, input *RebootBrokerInput, opts ...request.Option) (*RebootBrokerOutput, error)

RebootBrokerWithContext is the same as RebootBroker with the addition of the ability to pass a context and additional request options.

See RebootBroker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) TagResource added in v1.19.14

func (c *Kafka) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Managed Streaming for Kafka.

Adds tags to the specified MSK resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation TagResource for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

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

func (*Kafka) TagResourceRequest added in v1.19.14

func (c *Kafka) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) TagResourceWithContext added in v1.19.14

func (c *Kafka) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UntagResource added in v1.19.14

func (c *Kafka) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UntagResource for usage and error information.

Returned Error Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

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

func (*Kafka) UntagResourceRequest added in v1.19.14

func (c *Kafka) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) UntagResourceWithContext added in v1.19.14

func (c *Kafka) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateBrokerCount added in v1.25.14

func (c *Kafka) UpdateBrokerCount(input *UpdateBrokerCountInput) (*UpdateBrokerCountOutput, error)

UpdateBrokerCount API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateBrokerCount for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) UpdateBrokerCountRequest added in v1.25.14

func (c *Kafka) UpdateBrokerCountRequest(input *UpdateBrokerCountInput) (req *request.Request, output *UpdateBrokerCountOutput)

UpdateBrokerCountRequest generates a "aws/request.Request" representing the client's request for the UpdateBrokerCount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBrokerCount for more information on using the UpdateBrokerCount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateBrokerCountRequest method.
req, resp := client.UpdateBrokerCountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) UpdateBrokerCountWithContext added in v1.25.14

func (c *Kafka) UpdateBrokerCountWithContext(ctx aws.Context, input *UpdateBrokerCountInput, opts ...request.Option) (*UpdateBrokerCountOutput, error)

UpdateBrokerCountWithContext is the same as UpdateBrokerCount with the addition of the ability to pass a context and additional request options.

See UpdateBrokerCount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateBrokerStorage added in v1.19.41

func (c *Kafka) UpdateBrokerStorage(input *UpdateBrokerStorageInput) (*UpdateBrokerStorageOutput, error)

UpdateBrokerStorage API operation for Managed Streaming for Kafka.

Updates the EBS storage associated with MSK brokers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateBrokerStorage for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) UpdateBrokerStorageRequest added in v1.19.41

func (c *Kafka) UpdateBrokerStorageRequest(input *UpdateBrokerStorageInput) (req *request.Request, output *UpdateBrokerStorageOutput)

UpdateBrokerStorageRequest generates a "aws/request.Request" representing the client's request for the UpdateBrokerStorage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBrokerStorage for more information on using the UpdateBrokerStorage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateBrokerStorageRequest method.
req, resp := client.UpdateBrokerStorageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) UpdateBrokerStorageWithContext added in v1.19.41

func (c *Kafka) UpdateBrokerStorageWithContext(ctx aws.Context, input *UpdateBrokerStorageInput, opts ...request.Option) (*UpdateBrokerStorageOutput, error)

UpdateBrokerStorageWithContext is the same as UpdateBrokerStorage with the addition of the ability to pass a context and additional request options.

See UpdateBrokerStorage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateBrokerType added in v1.36.30

func (c *Kafka) UpdateBrokerType(input *UpdateBrokerTypeInput) (*UpdateBrokerTypeOutput, error)

UpdateBrokerType API operation for Managed Streaming for Kafka.

Updates all the brokers in the cluster to the specified type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateBrokerType for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateBrokerType

func (*Kafka) UpdateBrokerTypeRequest added in v1.36.30

func (c *Kafka) UpdateBrokerTypeRequest(input *UpdateBrokerTypeInput) (req *request.Request, output *UpdateBrokerTypeOutput)

UpdateBrokerTypeRequest generates a "aws/request.Request" representing the client's request for the UpdateBrokerType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBrokerType for more information on using the UpdateBrokerType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateBrokerTypeRequest method.
req, resp := client.UpdateBrokerTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateBrokerType

func (*Kafka) UpdateBrokerTypeWithContext added in v1.36.30

func (c *Kafka) UpdateBrokerTypeWithContext(ctx aws.Context, input *UpdateBrokerTypeInput, opts ...request.Option) (*UpdateBrokerTypeOutput, error)

UpdateBrokerTypeWithContext is the same as UpdateBrokerType with the addition of the ability to pass a context and additional request options.

See UpdateBrokerType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateClusterConfiguration added in v1.19.41

func (c *Kafka) UpdateClusterConfiguration(input *UpdateClusterConfigurationInput) (*UpdateClusterConfigurationOutput, error)

UpdateClusterConfiguration API operation for Managed Streaming for Kafka.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateClusterConfiguration for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

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

func (*Kafka) UpdateClusterConfigurationRequest added in v1.19.41

func (c *Kafka) UpdateClusterConfigurationRequest(input *UpdateClusterConfigurationInput) (req *request.Request, output *UpdateClusterConfigurationOutput)

UpdateClusterConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateClusterConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateClusterConfiguration for more information on using the UpdateClusterConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateClusterConfigurationRequest method.
req, resp := client.UpdateClusterConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) UpdateClusterConfigurationWithContext added in v1.19.41

func (c *Kafka) UpdateClusterConfigurationWithContext(ctx aws.Context, input *UpdateClusterConfigurationInput, opts ...request.Option) (*UpdateClusterConfigurationOutput, error)

UpdateClusterConfigurationWithContext is the same as UpdateClusterConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateClusterConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateClusterKafkaVersion added in v1.31.7

func (c *Kafka) UpdateClusterKafkaVersion(input *UpdateClusterKafkaVersionInput) (*UpdateClusterKafkaVersionOutput, error)

UpdateClusterKafkaVersion API operation for Managed Streaming for Kafka.

Updates the Apache Kafka version for the cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateClusterKafkaVersion for usage and error information.

Returned Error Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

  • NotFoundException Returns information about an error.

  • ServiceUnavailableException Returns information about an error.

  • TooManyRequestsException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateClusterKafkaVersion

func (*Kafka) UpdateClusterKafkaVersionRequest added in v1.31.7

func (c *Kafka) UpdateClusterKafkaVersionRequest(input *UpdateClusterKafkaVersionInput) (req *request.Request, output *UpdateClusterKafkaVersionOutput)

UpdateClusterKafkaVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateClusterKafkaVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateClusterKafkaVersion for more information on using the UpdateClusterKafkaVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateClusterKafkaVersionRequest method.
req, resp := client.UpdateClusterKafkaVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateClusterKafkaVersion

func (*Kafka) UpdateClusterKafkaVersionWithContext added in v1.31.7

func (c *Kafka) UpdateClusterKafkaVersionWithContext(ctx aws.Context, input *UpdateClusterKafkaVersionInput, opts ...request.Option) (*UpdateClusterKafkaVersionOutput, error)

UpdateClusterKafkaVersionWithContext is the same as UpdateClusterKafkaVersion with the addition of the ability to pass a context and additional request options.

See UpdateClusterKafkaVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateConfiguration added in v1.34.10

func (c *Kafka) UpdateConfiguration(input *UpdateConfigurationInput) (*UpdateConfigurationOutput, error)

UpdateConfiguration API operation for Managed Streaming for Kafka.

Updates an existing MSK configuration. The configuration must be in the Active state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateConfiguration for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateConfiguration

func (*Kafka) UpdateConfigurationRequest added in v1.34.10

func (c *Kafka) UpdateConfigurationRequest(input *UpdateConfigurationInput) (req *request.Request, output *UpdateConfigurationOutput)

UpdateConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConfiguration for more information on using the UpdateConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateConfigurationRequest method.
req, resp := client.UpdateConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateConfiguration

func (*Kafka) UpdateConfigurationWithContext added in v1.34.10

func (c *Kafka) UpdateConfigurationWithContext(ctx aws.Context, input *UpdateConfigurationInput, opts ...request.Option) (*UpdateConfigurationOutput, error)

UpdateConfigurationWithContext is the same as UpdateConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kafka) UpdateMonitoring added in v1.25.49

func (c *Kafka) UpdateMonitoring(input *UpdateMonitoringInput) (*UpdateMonitoringOutput, error)

UpdateMonitoring API operation for Managed Streaming for Kafka.

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Managed Streaming for Kafka's API operation UpdateMonitoring for usage and error information.

Returned Error Types:

  • ServiceUnavailableException Returns information about an error.

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*Kafka) UpdateMonitoringRequest added in v1.25.49

func (c *Kafka) UpdateMonitoringRequest(input *UpdateMonitoringInput) (req *request.Request, output *UpdateMonitoringOutput)

UpdateMonitoringRequest generates a "aws/request.Request" representing the client's request for the UpdateMonitoring operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMonitoring for more information on using the UpdateMonitoring API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateMonitoringRequest method.
req, resp := client.UpdateMonitoringRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Kafka) UpdateMonitoringWithContext added in v1.25.49

func (c *Kafka) UpdateMonitoringWithContext(ctx aws.Context, input *UpdateMonitoringInput, opts ...request.Option) (*UpdateMonitoringOutput, error)

UpdateMonitoringWithContext is the same as UpdateMonitoring with the addition of the ability to pass a context and additional request options.

See UpdateMonitoring for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type KafkaVersion added in v1.28.10

type KafkaVersion struct {

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

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

Information about a Kafka version.

func (KafkaVersion) GoString added in v1.28.10

func (s KafkaVersion) GoString() string

GoString returns the string representation

func (*KafkaVersion) SetStatus added in v1.28.10

func (s *KafkaVersion) SetStatus(v string) *KafkaVersion

SetStatus sets the Status field's value.

func (*KafkaVersion) SetVersion added in v1.28.10

func (s *KafkaVersion) SetVersion(v string) *KafkaVersion

SetVersion sets the Version field's value.

func (KafkaVersion) String added in v1.28.10

func (s KafkaVersion) String() string

String returns the string representation

type ListClusterOperationsInput added in v1.19.41

type ListClusterOperationsInput struct {

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

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

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

func (ListClusterOperationsInput) GoString added in v1.19.41

func (s ListClusterOperationsInput) GoString() string

GoString returns the string representation

func (*ListClusterOperationsInput) SetClusterArn added in v1.19.41

SetClusterArn sets the ClusterArn field's value.

func (*ListClusterOperationsInput) SetMaxResults added in v1.19.41

SetMaxResults sets the MaxResults field's value.

func (*ListClusterOperationsInput) SetNextToken added in v1.19.41

SetNextToken sets the NextToken field's value.

func (ListClusterOperationsInput) String added in v1.19.41

String returns the string representation

func (*ListClusterOperationsInput) Validate added in v1.19.41

func (s *ListClusterOperationsInput) Validate() error

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

type ListClusterOperationsOutput added in v1.19.41

type ListClusterOperationsOutput struct {

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

	// If the response of ListClusterOperations is truncated, it returns a NextToken
	// in the response. This Nexttoken should be sent in the subsequent request
	// to ListClusterOperations.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListClusterOperationsOutput) GoString added in v1.19.41

func (s ListClusterOperationsOutput) GoString() string

GoString returns the string representation

func (*ListClusterOperationsOutput) SetClusterOperationInfoList added in v1.19.41

SetClusterOperationInfoList sets the ClusterOperationInfoList field's value.

func (*ListClusterOperationsOutput) SetNextToken added in v1.19.41

SetNextToken sets the NextToken field's value.

func (ListClusterOperationsOutput) String added in v1.19.41

String returns the string representation

type ListClustersInput

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

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

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

func (ListClustersInput) GoString

func (s ListClustersInput) GoString() string

GoString returns the string representation

func (*ListClustersInput) SetClusterNameFilter

func (s *ListClustersInput) SetClusterNameFilter(v string) *ListClustersInput

SetClusterNameFilter sets the ClusterNameFilter field's value.

func (*ListClustersInput) SetMaxResults

func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput

SetMaxResults sets the MaxResults field's value.

func (*ListClustersInput) SetNextToken

func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput

SetNextToken sets the NextToken field's value.

func (ListClustersInput) String

func (s ListClustersInput) String() string

String returns the string representation

func (*ListClustersInput) Validate

func (s *ListClustersInput) Validate() error

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

type ListClustersOutput

type ListClustersOutput struct {

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

	// The paginated results marker. When the result of a ListClusters operation
	// is truncated, the call returns NextToken in the response. To get another
	// batch of clusters, provide this token in your next request.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListClustersOutput) GoString

func (s ListClustersOutput) GoString() string

GoString returns the string representation

func (*ListClustersOutput) SetClusterInfoList

func (s *ListClustersOutput) SetClusterInfoList(v []*ClusterInfo) *ListClustersOutput

SetClusterInfoList sets the ClusterInfoList field's value.

func (*ListClustersOutput) SetNextToken

func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput

SetNextToken sets the NextToken field's value.

func (ListClustersOutput) String

func (s ListClustersOutput) String() string

String returns the string representation

type ListConfigurationRevisionsInput added in v1.19.41

type ListConfigurationRevisionsInput struct {

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

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

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

func (ListConfigurationRevisionsInput) GoString added in v1.19.41

GoString returns the string representation

func (*ListConfigurationRevisionsInput) SetArn added in v1.19.41

SetArn sets the Arn field's value.

func (*ListConfigurationRevisionsInput) SetMaxResults added in v1.19.41

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationRevisionsInput) SetNextToken added in v1.19.41

SetNextToken sets the NextToken field's value.

func (ListConfigurationRevisionsInput) String added in v1.19.41

String returns the string representation

func (*ListConfigurationRevisionsInput) Validate added in v1.19.41

func (s *ListConfigurationRevisionsInput) Validate() error

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

type ListConfigurationRevisionsOutput added in v1.19.41

type ListConfigurationRevisionsOutput struct {

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

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

Information about revisions of an MSK configuration.

func (ListConfigurationRevisionsOutput) GoString added in v1.19.41

GoString returns the string representation

func (*ListConfigurationRevisionsOutput) SetNextToken added in v1.19.41

SetNextToken sets the NextToken field's value.

func (*ListConfigurationRevisionsOutput) SetRevisions added in v1.19.41

SetRevisions sets the Revisions field's value.

func (ListConfigurationRevisionsOutput) String added in v1.19.41

String returns the string representation

type ListConfigurationsInput added in v1.19.34

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

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

func (ListConfigurationsInput) GoString added in v1.19.34

func (s ListConfigurationsInput) GoString() string

GoString returns the string representation

func (*ListConfigurationsInput) SetMaxResults added in v1.19.34

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationsInput) SetNextToken added in v1.19.34

SetNextToken sets the NextToken field's value.

func (ListConfigurationsInput) String added in v1.19.34

func (s ListConfigurationsInput) String() string

String returns the string representation

func (*ListConfigurationsInput) Validate added in v1.19.41

func (s *ListConfigurationsInput) Validate() error

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

type ListConfigurationsOutput added in v1.19.34

type ListConfigurationsOutput struct {

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

	// The paginated results marker. When the result of a ListConfigurations operation
	// is truncated, the call returns NextToken in the response. To get another
	// batch of configurations, provide this token in your next request.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

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

func (ListConfigurationsOutput) GoString added in v1.19.34

func (s ListConfigurationsOutput) GoString() string

GoString returns the string representation

func (*ListConfigurationsOutput) SetConfigurations added in v1.19.34

SetConfigurations sets the Configurations field's value.

func (*ListConfigurationsOutput) SetNextToken added in v1.19.34

SetNextToken sets the NextToken field's value.

func (ListConfigurationsOutput) String added in v1.19.34

func (s ListConfigurationsOutput) String() string

String returns the string representation

type ListKafkaVersionsInput added in v1.28.10

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

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

func (ListKafkaVersionsInput) GoString added in v1.28.10

func (s ListKafkaVersionsInput) GoString() string

GoString returns the string representation

func (*ListKafkaVersionsInput) SetMaxResults added in v1.28.10

SetMaxResults sets the MaxResults field's value.

func (*ListKafkaVersionsInput) SetNextToken added in v1.28.10

SetNextToken sets the NextToken field's value.

func (ListKafkaVersionsInput) String added in v1.28.10

func (s ListKafkaVersionsInput) String() string

String returns the string representation

func (*ListKafkaVersionsInput) Validate added in v1.28.10

func (s *ListKafkaVersionsInput) Validate() error

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

type ListKafkaVersionsOutput added in v1.28.10

type ListKafkaVersionsOutput struct {

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

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

Response for ListKafkaVersions.

func (ListKafkaVersionsOutput) GoString added in v1.28.10

func (s ListKafkaVersionsOutput) GoString() string

GoString returns the string representation

func (*ListKafkaVersionsOutput) SetKafkaVersions added in v1.28.10

SetKafkaVersions sets the KafkaVersions field's value.

func (*ListKafkaVersionsOutput) SetNextToken added in v1.28.10

SetNextToken sets the NextToken field's value.

func (ListKafkaVersionsOutput) String added in v1.28.10

func (s ListKafkaVersionsOutput) String() string

String returns the string representation

type ListNodesInput

type ListNodesInput struct {

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

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

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

func (ListNodesInput) GoString

func (s ListNodesInput) GoString() string

GoString returns the string representation

func (*ListNodesInput) SetClusterArn

func (s *ListNodesInput) SetClusterArn(v string) *ListNodesInput

SetClusterArn sets the ClusterArn field's value.

func (*ListNodesInput) SetMaxResults

func (s *ListNodesInput) SetMaxResults(v int64) *ListNodesInput

SetMaxResults sets the MaxResults field's value.

func (*ListNodesInput) SetNextToken

func (s *ListNodesInput) SetNextToken(v string) *ListNodesInput

SetNextToken sets the NextToken field's value.

func (ListNodesInput) String

func (s ListNodesInput) String() string

String returns the string representation

func (*ListNodesInput) Validate

func (s *ListNodesInput) Validate() error

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

type ListNodesOutput

type ListNodesOutput struct {

	// The paginated results marker. When the result of a ListNodes operation is
	// truncated, the call returns NextToken in the response. To get another batch
	// of nodes, provide this token in your next request.
	NextToken *string `locationName:"nextToken" type:"string"`

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

Information about nodes in the cluster.

func (ListNodesOutput) GoString

func (s ListNodesOutput) GoString() string

GoString returns the string representation

func (*ListNodesOutput) SetNextToken

func (s *ListNodesOutput) SetNextToken(v string) *ListNodesOutput

SetNextToken sets the NextToken field's value.

func (*ListNodesOutput) SetNodeInfoList

func (s *ListNodesOutput) SetNodeInfoList(v []*NodeInfo) *ListNodesOutput

SetNodeInfoList sets the NodeInfoList field's value.

func (ListNodesOutput) String

func (s ListNodesOutput) String() string

String returns the string representation

type ListScramSecretsInput added in v1.34.24

type ListScramSecretsInput struct {

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

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

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

func (ListScramSecretsInput) GoString added in v1.34.24

func (s ListScramSecretsInput) GoString() string

GoString returns the string representation

func (*ListScramSecretsInput) SetClusterArn added in v1.34.24

func (s *ListScramSecretsInput) SetClusterArn(v string) *ListScramSecretsInput

SetClusterArn sets the ClusterArn field's value.

func (*ListScramSecretsInput) SetMaxResults added in v1.34.24

func (s *ListScramSecretsInput) SetMaxResults(v int64) *ListScramSecretsInput

SetMaxResults sets the MaxResults field's value.

func (*ListScramSecretsInput) SetNextToken added in v1.34.24

SetNextToken sets the NextToken field's value.

func (ListScramSecretsInput) String added in v1.34.24

func (s ListScramSecretsInput) String() string

String returns the string representation

func (*ListScramSecretsInput) Validate added in v1.34.24

func (s *ListScramSecretsInput) Validate() error

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

type ListScramSecretsOutput added in v1.34.24

type ListScramSecretsOutput struct {

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

	// The list of scram secrets associated with the cluster.
	SecretArnList []*string `locationName:"secretArnList" type:"list"`
	// contains filtered or unexported fields
}

Information about scram secrets associated to the cluster.

func (ListScramSecretsOutput) GoString added in v1.34.24

func (s ListScramSecretsOutput) GoString() string

GoString returns the string representation

func (*ListScramSecretsOutput) SetNextToken added in v1.34.24

SetNextToken sets the NextToken field's value.

func (*ListScramSecretsOutput) SetSecretArnList added in v1.34.24

func (s *ListScramSecretsOutput) SetSecretArnList(v []*string) *ListScramSecretsOutput

SetSecretArnList sets the SecretArnList field's value.

func (ListScramSecretsOutput) String added in v1.34.24

func (s ListScramSecretsOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.19.14

type ListTagsForResourceInput struct {

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

func (ListTagsForResourceInput) GoString added in v1.19.14

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.19.14

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.19.14

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.19.14

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.19.14

type ListTagsForResourceOutput struct {

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

Response of listing tags for a resource.

func (ListTagsForResourceOutput) GoString added in v1.19.14

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.19.14

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.19.14

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type LoggingInfo added in v1.29.10

type LoggingInfo struct {

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

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

func (LoggingInfo) GoString added in v1.29.10

func (s LoggingInfo) GoString() string

GoString returns the string representation

func (*LoggingInfo) SetBrokerLogs added in v1.29.10

func (s *LoggingInfo) SetBrokerLogs(v *BrokerLogs) *LoggingInfo

SetBrokerLogs sets the BrokerLogs field's value.

func (LoggingInfo) String added in v1.29.10

func (s LoggingInfo) String() string

String returns the string representation

func (*LoggingInfo) Validate added in v1.29.10

func (s *LoggingInfo) Validate() error

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

type MutableClusterInfo added in v1.19.41

type MutableClusterInfo struct {

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

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

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

	// The Amazon MSK broker type that you want all of the brokers in this cluster
	// to be.
	InstanceType *string `locationName:"instanceType" min:"5" type:"string"`

	KafkaVersion *string `locationName:"kafkaVersion" type:"string"`

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

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

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

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

func (MutableClusterInfo) GoString added in v1.19.41

func (s MutableClusterInfo) GoString() string

GoString returns the string representation

func (*MutableClusterInfo) SetBrokerEBSVolumeInfo added in v1.19.41

func (s *MutableClusterInfo) SetBrokerEBSVolumeInfo(v []*BrokerEBSVolumeInfo) *MutableClusterInfo

SetBrokerEBSVolumeInfo sets the BrokerEBSVolumeInfo field's value.

func (*MutableClusterInfo) SetConfigurationInfo added in v1.19.41

func (s *MutableClusterInfo) SetConfigurationInfo(v *ConfigurationInfo) *MutableClusterInfo

SetConfigurationInfo sets the ConfigurationInfo field's value.

func (*MutableClusterInfo) SetEnhancedMonitoring added in v1.25.49

func (s *MutableClusterInfo) SetEnhancedMonitoring(v string) *MutableClusterInfo

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*MutableClusterInfo) SetInstanceType added in v1.36.30

func (s *MutableClusterInfo) SetInstanceType(v string) *MutableClusterInfo

SetInstanceType sets the InstanceType field's value.

func (*MutableClusterInfo) SetKafkaVersion added in v1.31.7

func (s *MutableClusterInfo) SetKafkaVersion(v string) *MutableClusterInfo

SetKafkaVersion sets the KafkaVersion field's value.

func (*MutableClusterInfo) SetLoggingInfo added in v1.29.10

func (s *MutableClusterInfo) SetLoggingInfo(v *LoggingInfo) *MutableClusterInfo

SetLoggingInfo sets the LoggingInfo field's value.

func (*MutableClusterInfo) SetNumberOfBrokerNodes added in v1.19.41

func (s *MutableClusterInfo) SetNumberOfBrokerNodes(v int64) *MutableClusterInfo

SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value.

func (*MutableClusterInfo) SetOpenMonitoring added in v1.25.49

func (s *MutableClusterInfo) SetOpenMonitoring(v *OpenMonitoring) *MutableClusterInfo

SetOpenMonitoring sets the OpenMonitoring field's value.

func (MutableClusterInfo) String added in v1.19.41

func (s MutableClusterInfo) String() string

String returns the string representation

type NodeExporter added in v1.25.49

type NodeExporter struct {

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

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

func (NodeExporter) GoString added in v1.25.49

func (s NodeExporter) GoString() string

GoString returns the string representation

func (*NodeExporter) SetEnabledInBroker added in v1.25.49

func (s *NodeExporter) SetEnabledInBroker(v bool) *NodeExporter

SetEnabledInBroker sets the EnabledInBroker field's value.

func (NodeExporter) String added in v1.25.49

func (s NodeExporter) String() string

String returns the string representation

type NodeExporterInfo added in v1.25.49

type NodeExporterInfo struct {

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

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

func (NodeExporterInfo) GoString added in v1.25.49

func (s NodeExporterInfo) GoString() string

GoString returns the string representation

func (*NodeExporterInfo) SetEnabledInBroker added in v1.25.49

func (s *NodeExporterInfo) SetEnabledInBroker(v bool) *NodeExporterInfo

SetEnabledInBroker sets the EnabledInBroker field's value.

func (NodeExporterInfo) String added in v1.25.49

func (s NodeExporterInfo) String() string

String returns the string representation

func (*NodeExporterInfo) Validate added in v1.25.49

func (s *NodeExporterInfo) Validate() error

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

type NodeInfo

type NodeInfo struct {

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

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

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

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

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

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

The node information object.

func (NodeInfo) GoString

func (s NodeInfo) GoString() string

GoString returns the string representation

func (*NodeInfo) SetAddedToClusterTime

func (s *NodeInfo) SetAddedToClusterTime(v string) *NodeInfo

SetAddedToClusterTime sets the AddedToClusterTime field's value.

func (*NodeInfo) SetBrokerNodeInfo

func (s *NodeInfo) SetBrokerNodeInfo(v *BrokerNodeInfo) *NodeInfo

SetBrokerNodeInfo sets the BrokerNodeInfo field's value.

func (*NodeInfo) SetInstanceType

func (s *NodeInfo) SetInstanceType(v string) *NodeInfo

SetInstanceType sets the InstanceType field's value.

func (*NodeInfo) SetNodeARN

func (s *NodeInfo) SetNodeARN(v string) *NodeInfo

SetNodeARN sets the NodeARN field's value.

func (*NodeInfo) SetNodeType

func (s *NodeInfo) SetNodeType(v string) *NodeInfo

SetNodeType sets the NodeType field's value.

func (*NodeInfo) SetZookeeperNodeInfo

func (s *NodeInfo) SetZookeeperNodeInfo(v *ZookeeperNodeInfo) *NodeInfo

SetZookeeperNodeInfo sets the ZookeeperNodeInfo field's value.

func (NodeInfo) String

func (s NodeInfo) String() string

String returns the string representation

type NotFoundException added in v1.28.0

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*NotFoundException) Code added in v1.28.0

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message added in v1.28.0

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0

func (s NotFoundException) String() string

String returns the string representation

type OpenMonitoring added in v1.25.49

type OpenMonitoring struct {

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

JMX and Node monitoring for the MSK cluster.

func (OpenMonitoring) GoString added in v1.25.49

func (s OpenMonitoring) GoString() string

GoString returns the string representation

func (*OpenMonitoring) SetPrometheus added in v1.25.49

func (s *OpenMonitoring) SetPrometheus(v *Prometheus) *OpenMonitoring

SetPrometheus sets the Prometheus field's value.

func (OpenMonitoring) String added in v1.25.49

func (s OpenMonitoring) String() string

String returns the string representation

type OpenMonitoringInfo added in v1.25.49

type OpenMonitoringInfo struct {

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

JMX and Node monitoring for the MSK cluster.

func (OpenMonitoringInfo) GoString added in v1.25.49

func (s OpenMonitoringInfo) GoString() string

GoString returns the string representation

func (*OpenMonitoringInfo) SetPrometheus added in v1.25.49

SetPrometheus sets the Prometheus field's value.

func (OpenMonitoringInfo) String added in v1.25.49

func (s OpenMonitoringInfo) String() string

String returns the string representation

func (*OpenMonitoringInfo) Validate added in v1.25.49

func (s *OpenMonitoringInfo) Validate() error

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

type Prometheus added in v1.25.49

type Prometheus struct {

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

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

Prometheus settings for open monitoring.

func (Prometheus) GoString added in v1.25.49

func (s Prometheus) GoString() string

GoString returns the string representation

func (*Prometheus) SetJmxExporter added in v1.25.49

func (s *Prometheus) SetJmxExporter(v *JmxExporter) *Prometheus

SetJmxExporter sets the JmxExporter field's value.

func (*Prometheus) SetNodeExporter added in v1.25.49

func (s *Prometheus) SetNodeExporter(v *NodeExporter) *Prometheus

SetNodeExporter sets the NodeExporter field's value.

func (Prometheus) String added in v1.25.49

func (s Prometheus) String() string

String returns the string representation

type PrometheusInfo added in v1.25.49

type PrometheusInfo struct {

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

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

Prometheus settings.

func (PrometheusInfo) GoString added in v1.25.49

func (s PrometheusInfo) GoString() string

GoString returns the string representation

func (*PrometheusInfo) SetJmxExporter added in v1.25.49

func (s *PrometheusInfo) SetJmxExporter(v *JmxExporterInfo) *PrometheusInfo

SetJmxExporter sets the JmxExporter field's value.

func (*PrometheusInfo) SetNodeExporter added in v1.25.49

func (s *PrometheusInfo) SetNodeExporter(v *NodeExporterInfo) *PrometheusInfo

SetNodeExporter sets the NodeExporter field's value.

func (PrometheusInfo) String added in v1.25.49

func (s PrometheusInfo) String() string

String returns the string representation

func (*PrometheusInfo) Validate added in v1.25.49

func (s *PrometheusInfo) Validate() error

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

type RebootBrokerInput added in v1.33.16

type RebootBrokerInput struct {

	// The list of broker ids to be rebooted.
	//
	// BrokerIds is a required field
	BrokerIds []*string `locationName:"brokerIds" type:"list" required:"true"`

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

Request body for RebootBrokerNode action.

func (RebootBrokerInput) GoString added in v1.33.16

func (s RebootBrokerInput) GoString() string

GoString returns the string representation

func (*RebootBrokerInput) SetBrokerIds added in v1.33.16

func (s *RebootBrokerInput) SetBrokerIds(v []*string) *RebootBrokerInput

SetBrokerIds sets the BrokerIds field's value.

func (*RebootBrokerInput) SetClusterArn added in v1.33.16

func (s *RebootBrokerInput) SetClusterArn(v string) *RebootBrokerInput

SetClusterArn sets the ClusterArn field's value.

func (RebootBrokerInput) String added in v1.33.16

func (s RebootBrokerInput) String() string

String returns the string representation

func (*RebootBrokerInput) Validate added in v1.33.16

func (s *RebootBrokerInput) Validate() error

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

type RebootBrokerOutput added in v1.33.16

type RebootBrokerOutput struct {

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

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

Response body for RebootBrokers action.

func (RebootBrokerOutput) GoString added in v1.33.16

func (s RebootBrokerOutput) GoString() string

GoString returns the string representation

func (*RebootBrokerOutput) SetClusterArn added in v1.33.16

func (s *RebootBrokerOutput) SetClusterArn(v string) *RebootBrokerOutput

SetClusterArn sets the ClusterArn field's value.

func (*RebootBrokerOutput) SetClusterOperationArn added in v1.33.16

func (s *RebootBrokerOutput) SetClusterOperationArn(v string) *RebootBrokerOutput

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (RebootBrokerOutput) String added in v1.33.16

func (s RebootBrokerOutput) String() string

String returns the string representation

type S3 added in v1.29.10

type S3 struct {

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

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

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

The details of the Amazon S3 destination for broker logs.

func (S3) GoString added in v1.29.10

func (s S3) GoString() string

GoString returns the string representation

func (*S3) SetBucket added in v1.29.10

func (s *S3) SetBucket(v string) *S3

SetBucket sets the Bucket field's value.

func (*S3) SetEnabled added in v1.29.10

func (s *S3) SetEnabled(v bool) *S3

SetEnabled sets the Enabled field's value.

func (*S3) SetPrefix added in v1.29.10

func (s *S3) SetPrefix(v string) *S3

SetPrefix sets the Prefix field's value.

func (S3) String added in v1.29.10

func (s S3) String() string

String returns the string representation

func (*S3) Validate added in v1.29.10

func (s *S3) Validate() error

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

type Sasl added in v1.34.24

type Sasl struct {
	Scram *Scram `locationName:"scram" type:"structure"`
	// contains filtered or unexported fields
}

func (Sasl) GoString added in v1.34.24

func (s Sasl) GoString() string

GoString returns the string representation

func (*Sasl) SetScram added in v1.34.24

func (s *Sasl) SetScram(v *Scram) *Sasl

SetScram sets the Scram field's value.

func (Sasl) String added in v1.34.24

func (s Sasl) String() string

String returns the string representation

type Scram added in v1.34.24

type Scram struct {
	Enabled *bool `locationName:"enabled" type:"boolean"`
	// contains filtered or unexported fields
}

func (Scram) GoString added in v1.34.24

func (s Scram) GoString() string

GoString returns the string representation

func (*Scram) SetEnabled added in v1.34.24

func (s *Scram) SetEnabled(v bool) *Scram

SetEnabled sets the Enabled field's value.

func (Scram) String added in v1.34.24

func (s Scram) String() string

String returns the string representation

type ServiceUnavailableException added in v1.28.0

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation

type StorageInfo

type StorageInfo struct {

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

Contains information about storage volumes attached to MSK broker nodes.

func (StorageInfo) GoString

func (s StorageInfo) GoString() string

GoString returns the string representation

func (*StorageInfo) SetEbsStorageInfo

func (s *StorageInfo) SetEbsStorageInfo(v *EBSStorageInfo) *StorageInfo

SetEbsStorageInfo sets the EbsStorageInfo field's value.

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 v1.19.14

type TagResourceInput struct {

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

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

Tag a resource.

func (TagResourceInput) GoString added in v1.19.14

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.19.14

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.19.14

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.19.14

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.19.14

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.19.14

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

func (TagResourceOutput) GoString added in v1.19.14

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.19.14

func (s TagResourceOutput) String() string

String returns the string representation

type Tls added in v1.19.41

type Tls struct {

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

Details for client authentication using TLS.

func (Tls) GoString added in v1.19.41

func (s Tls) GoString() string

GoString returns the string representation

func (*Tls) SetCertificateAuthorityArnList added in v1.19.41

func (s *Tls) SetCertificateAuthorityArnList(v []*string) *Tls

SetCertificateAuthorityArnList sets the CertificateAuthorityArnList field's value.

func (Tls) String added in v1.19.41

func (s Tls) String() string

String returns the string representation

type TooManyRequestsException added in v1.28.0

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*TooManyRequestsException) Code added in v1.28.0

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0

func (s TooManyRequestsException) GoString() string

GoString returns the string representation

func (*TooManyRequestsException) Message added in v1.28.0

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0

func (s TooManyRequestsException) String() string

String returns the string representation

type UnauthorizedException added in v1.28.0

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	InvalidParameter *string `locationName:"invalidParameter" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*UnauthorizedException) Code added in v1.28.0

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0

func (s UnauthorizedException) GoString() string

GoString returns the string representation

func (*UnauthorizedException) Message added in v1.28.0

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.28.0

func (s UnauthorizedException) String() string

String returns the string representation

type UnprocessedScramSecret added in v1.34.24

type UnprocessedScramSecret struct {
	ErrorCode *string `locationName:"errorCode" type:"string"`

	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	SecretArn *string `locationName:"secretArn" type:"string"`
	// contains filtered or unexported fields
}

func (UnprocessedScramSecret) GoString added in v1.34.24

func (s UnprocessedScramSecret) GoString() string

GoString returns the string representation

func (*UnprocessedScramSecret) SetErrorCode added in v1.34.24

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedScramSecret) SetErrorMessage added in v1.34.24

func (s *UnprocessedScramSecret) SetErrorMessage(v string) *UnprocessedScramSecret

SetErrorMessage sets the ErrorMessage field's value.

func (*UnprocessedScramSecret) SetSecretArn added in v1.34.24

SetSecretArn sets the SecretArn field's value.

func (UnprocessedScramSecret) String added in v1.34.24

func (s UnprocessedScramSecret) String() string

String returns the string representation

type UntagResourceInput added in v1.19.14

type UntagResourceInput struct {

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

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

func (UntagResourceInput) GoString added in v1.19.14

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.19.14

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.19.14

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.19.14

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.19.14

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.19.14

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

func (UntagResourceOutput) GoString added in v1.19.14

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.19.14

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateBrokerCountInput added in v1.25.14

type UpdateBrokerCountInput struct {

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

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

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

Request body for UpdateBrokerCount.

func (UpdateBrokerCountInput) GoString added in v1.25.14

func (s UpdateBrokerCountInput) GoString() string

GoString returns the string representation

func (*UpdateBrokerCountInput) SetClusterArn added in v1.25.14

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerCountInput) SetCurrentVersion added in v1.25.14

func (s *UpdateBrokerCountInput) SetCurrentVersion(v string) *UpdateBrokerCountInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateBrokerCountInput) SetTargetNumberOfBrokerNodes added in v1.25.14

func (s *UpdateBrokerCountInput) SetTargetNumberOfBrokerNodes(v int64) *UpdateBrokerCountInput

SetTargetNumberOfBrokerNodes sets the TargetNumberOfBrokerNodes field's value.

func (UpdateBrokerCountInput) String added in v1.25.14

func (s UpdateBrokerCountInput) String() string

String returns the string representation

func (*UpdateBrokerCountInput) Validate added in v1.25.14

func (s *UpdateBrokerCountInput) Validate() error

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

type UpdateBrokerCountOutput added in v1.25.14

type UpdateBrokerCountOutput struct {

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

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

Response body for UpdateBrokerCount.

func (UpdateBrokerCountOutput) GoString added in v1.25.14

func (s UpdateBrokerCountOutput) GoString() string

GoString returns the string representation

func (*UpdateBrokerCountOutput) SetClusterArn added in v1.25.14

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerCountOutput) SetClusterOperationArn added in v1.25.14

func (s *UpdateBrokerCountOutput) SetClusterOperationArn(v string) *UpdateBrokerCountOutput

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateBrokerCountOutput) String added in v1.25.14

func (s UpdateBrokerCountOutput) String() string

String returns the string representation

type UpdateBrokerStorageInput added in v1.19.41

type UpdateBrokerStorageInput struct {

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

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

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

Request object for UpdateBrokerStorage.

func (UpdateBrokerStorageInput) GoString added in v1.19.41

func (s UpdateBrokerStorageInput) GoString() string

GoString returns the string representation

func (*UpdateBrokerStorageInput) SetClusterArn added in v1.19.41

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerStorageInput) SetCurrentVersion added in v1.19.41

func (s *UpdateBrokerStorageInput) SetCurrentVersion(v string) *UpdateBrokerStorageInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateBrokerStorageInput) SetTargetBrokerEBSVolumeInfo added in v1.19.41

func (s *UpdateBrokerStorageInput) SetTargetBrokerEBSVolumeInfo(v []*BrokerEBSVolumeInfo) *UpdateBrokerStorageInput

SetTargetBrokerEBSVolumeInfo sets the TargetBrokerEBSVolumeInfo field's value.

func (UpdateBrokerStorageInput) String added in v1.19.41

func (s UpdateBrokerStorageInput) String() string

String returns the string representation

func (*UpdateBrokerStorageInput) Validate added in v1.19.41

func (s *UpdateBrokerStorageInput) Validate() error

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

type UpdateBrokerStorageOutput added in v1.19.41

type UpdateBrokerStorageOutput struct {

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

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

Response body for UpdateBrokerStorage.

func (UpdateBrokerStorageOutput) GoString added in v1.19.41

func (s UpdateBrokerStorageOutput) GoString() string

GoString returns the string representation

func (*UpdateBrokerStorageOutput) SetClusterArn added in v1.19.41

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerStorageOutput) SetClusterOperationArn added in v1.19.41

func (s *UpdateBrokerStorageOutput) SetClusterOperationArn(v string) *UpdateBrokerStorageOutput

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateBrokerStorageOutput) String added in v1.19.41

func (s UpdateBrokerStorageOutput) String() string

String returns the string representation

type UpdateBrokerTypeInput added in v1.36.30

type UpdateBrokerTypeInput struct {

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

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

	// The Amazon MSK broker type that you want all of the brokers in this cluster
	// to be.
	//
	// TargetInstanceType is a required field
	TargetInstanceType *string `locationName:"targetInstanceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request body for UpdateBrokerType.

func (UpdateBrokerTypeInput) GoString added in v1.36.30

func (s UpdateBrokerTypeInput) GoString() string

GoString returns the string representation

func (*UpdateBrokerTypeInput) SetClusterArn added in v1.36.30

func (s *UpdateBrokerTypeInput) SetClusterArn(v string) *UpdateBrokerTypeInput

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerTypeInput) SetCurrentVersion added in v1.36.30

func (s *UpdateBrokerTypeInput) SetCurrentVersion(v string) *UpdateBrokerTypeInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateBrokerTypeInput) SetTargetInstanceType added in v1.36.30

func (s *UpdateBrokerTypeInput) SetTargetInstanceType(v string) *UpdateBrokerTypeInput

SetTargetInstanceType sets the TargetInstanceType field's value.

func (UpdateBrokerTypeInput) String added in v1.36.30

func (s UpdateBrokerTypeInput) String() string

String returns the string representation

func (*UpdateBrokerTypeInput) Validate added in v1.36.30

func (s *UpdateBrokerTypeInput) Validate() error

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

type UpdateBrokerTypeOutput added in v1.36.30

type UpdateBrokerTypeOutput struct {

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

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

Response body for UpdateBrokerType.

func (UpdateBrokerTypeOutput) GoString added in v1.36.30

func (s UpdateBrokerTypeOutput) GoString() string

GoString returns the string representation

func (*UpdateBrokerTypeOutput) SetClusterArn added in v1.36.30

SetClusterArn sets the ClusterArn field's value.

func (*UpdateBrokerTypeOutput) SetClusterOperationArn added in v1.36.30

func (s *UpdateBrokerTypeOutput) SetClusterOperationArn(v string) *UpdateBrokerTypeOutput

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateBrokerTypeOutput) String added in v1.36.30

func (s UpdateBrokerTypeOutput) String() string

String returns the string representation

type UpdateClusterConfigurationInput added in v1.19.41

type UpdateClusterConfigurationInput struct {

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

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

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

Request body for UpdateClusterConfiguration.

func (UpdateClusterConfigurationInput) GoString added in v1.19.41

GoString returns the string representation

func (*UpdateClusterConfigurationInput) SetClusterArn added in v1.19.41

SetClusterArn sets the ClusterArn field's value.

func (*UpdateClusterConfigurationInput) SetConfigurationInfo added in v1.19.41

SetConfigurationInfo sets the ConfigurationInfo field's value.

func (*UpdateClusterConfigurationInput) SetCurrentVersion added in v1.19.41

SetCurrentVersion sets the CurrentVersion field's value.

func (UpdateClusterConfigurationInput) String added in v1.19.41

String returns the string representation

func (*UpdateClusterConfigurationInput) Validate added in v1.19.41

func (s *UpdateClusterConfigurationInput) Validate() error

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

type UpdateClusterConfigurationOutput added in v1.19.41

type UpdateClusterConfigurationOutput struct {

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

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

Response body for UpdateClusterConfiguration.

func (UpdateClusterConfigurationOutput) GoString added in v1.19.41

GoString returns the string representation

func (*UpdateClusterConfigurationOutput) SetClusterArn added in v1.19.41

SetClusterArn sets the ClusterArn field's value.

func (*UpdateClusterConfigurationOutput) SetClusterOperationArn added in v1.19.41

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateClusterConfigurationOutput) String added in v1.19.41

String returns the string representation

type UpdateClusterKafkaVersionInput added in v1.31.7

type UpdateClusterKafkaVersionInput struct {

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

	// Specifies the configuration to use for the brokers.
	ConfigurationInfo *ConfigurationInfo `locationName:"configurationInfo" type:"structure"`

	// Current cluster version.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"`

	// Target Kafka version.
	//
	// TargetKafkaVersion is a required field
	TargetKafkaVersion *string `locationName:"targetKafkaVersion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request body for UpdateClusterKafkaVersion.

func (UpdateClusterKafkaVersionInput) GoString added in v1.31.7

GoString returns the string representation

func (*UpdateClusterKafkaVersionInput) SetClusterArn added in v1.31.7

SetClusterArn sets the ClusterArn field's value.

func (*UpdateClusterKafkaVersionInput) SetConfigurationInfo added in v1.31.7

SetConfigurationInfo sets the ConfigurationInfo field's value.

func (*UpdateClusterKafkaVersionInput) SetCurrentVersion added in v1.31.7

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateClusterKafkaVersionInput) SetTargetKafkaVersion added in v1.31.7

SetTargetKafkaVersion sets the TargetKafkaVersion field's value.

func (UpdateClusterKafkaVersionInput) String added in v1.31.7

String returns the string representation

func (*UpdateClusterKafkaVersionInput) Validate added in v1.31.7

func (s *UpdateClusterKafkaVersionInput) Validate() error

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

type UpdateClusterKafkaVersionOutput added in v1.31.7

type UpdateClusterKafkaVersionOutput struct {

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

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

Response body for UpdateClusterKafkaVersion.

func (UpdateClusterKafkaVersionOutput) GoString added in v1.31.7

GoString returns the string representation

func (*UpdateClusterKafkaVersionOutput) SetClusterArn added in v1.31.7

SetClusterArn sets the ClusterArn field's value.

func (*UpdateClusterKafkaVersionOutput) SetClusterOperationArn added in v1.31.7

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateClusterKafkaVersionOutput) String added in v1.31.7

String returns the string representation

type UpdateConfigurationInput added in v1.34.10

type UpdateConfigurationInput struct {

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

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

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

func (UpdateConfigurationInput) GoString added in v1.34.10

func (s UpdateConfigurationInput) GoString() string

GoString returns the string representation

func (*UpdateConfigurationInput) SetArn added in v1.34.10

SetArn sets the Arn field's value.

func (*UpdateConfigurationInput) SetDescription added in v1.34.10

SetDescription sets the Description field's value.

func (*UpdateConfigurationInput) SetServerProperties added in v1.34.10

func (s *UpdateConfigurationInput) SetServerProperties(v []byte) *UpdateConfigurationInput

SetServerProperties sets the ServerProperties field's value.

func (UpdateConfigurationInput) String added in v1.34.10

func (s UpdateConfigurationInput) String() string

String returns the string representation

func (*UpdateConfigurationInput) Validate added in v1.34.10

func (s *UpdateConfigurationInput) Validate() error

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

type UpdateConfigurationOutput added in v1.34.10

type UpdateConfigurationOutput struct {

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

	// Latest revision of the configuration.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`
	// contains filtered or unexported fields
}

Response body for UpdateConfiguration.

func (UpdateConfigurationOutput) GoString added in v1.34.10

func (s UpdateConfigurationOutput) GoString() string

GoString returns the string representation

func (*UpdateConfigurationOutput) SetArn added in v1.34.10

SetArn sets the Arn field's value.

func (*UpdateConfigurationOutput) SetLatestRevision added in v1.34.10

SetLatestRevision sets the LatestRevision field's value.

func (UpdateConfigurationOutput) String added in v1.34.10

func (s UpdateConfigurationOutput) String() string

String returns the string representation

type UpdateMonitoringInput added in v1.25.49

type UpdateMonitoringInput struct {

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

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

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

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

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

Request body for UpdateMonitoring.

func (UpdateMonitoringInput) GoString added in v1.25.49

func (s UpdateMonitoringInput) GoString() string

GoString returns the string representation

func (*UpdateMonitoringInput) SetClusterArn added in v1.25.49

func (s *UpdateMonitoringInput) SetClusterArn(v string) *UpdateMonitoringInput

SetClusterArn sets the ClusterArn field's value.

func (*UpdateMonitoringInput) SetCurrentVersion added in v1.25.49

func (s *UpdateMonitoringInput) SetCurrentVersion(v string) *UpdateMonitoringInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateMonitoringInput) SetEnhancedMonitoring added in v1.25.49

func (s *UpdateMonitoringInput) SetEnhancedMonitoring(v string) *UpdateMonitoringInput

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*UpdateMonitoringInput) SetLoggingInfo added in v1.29.10

SetLoggingInfo sets the LoggingInfo field's value.

func (*UpdateMonitoringInput) SetOpenMonitoring added in v1.25.49

SetOpenMonitoring sets the OpenMonitoring field's value.

func (UpdateMonitoringInput) String added in v1.25.49

func (s UpdateMonitoringInput) String() string

String returns the string representation

func (*UpdateMonitoringInput) Validate added in v1.25.49

func (s *UpdateMonitoringInput) Validate() error

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

type UpdateMonitoringOutput added in v1.25.49

type UpdateMonitoringOutput struct {

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

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

Response body for UpdateMonitoring.

func (UpdateMonitoringOutput) GoString added in v1.25.49

func (s UpdateMonitoringOutput) GoString() string

GoString returns the string representation

func (*UpdateMonitoringOutput) SetClusterArn added in v1.25.49

SetClusterArn sets the ClusterArn field's value.

func (*UpdateMonitoringOutput) SetClusterOperationArn added in v1.25.49

func (s *UpdateMonitoringOutput) SetClusterOperationArn(v string) *UpdateMonitoringOutput

SetClusterOperationArn sets the ClusterOperationArn field's value.

func (UpdateMonitoringOutput) String added in v1.25.49

func (s UpdateMonitoringOutput) String() string

String returns the string representation

type ZookeeperNodeInfo

type ZookeeperNodeInfo struct {

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

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

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

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

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

Zookeeper node information.

func (ZookeeperNodeInfo) GoString

func (s ZookeeperNodeInfo) GoString() string

GoString returns the string representation

func (*ZookeeperNodeInfo) SetAttachedENIId

func (s *ZookeeperNodeInfo) SetAttachedENIId(v string) *ZookeeperNodeInfo

SetAttachedENIId sets the AttachedENIId field's value.

func (*ZookeeperNodeInfo) SetClientVpcIpAddress

func (s *ZookeeperNodeInfo) SetClientVpcIpAddress(v string) *ZookeeperNodeInfo

SetClientVpcIpAddress sets the ClientVpcIpAddress field's value.

func (*ZookeeperNodeInfo) SetEndpoints added in v1.19.41

func (s *ZookeeperNodeInfo) SetEndpoints(v []*string) *ZookeeperNodeInfo

SetEndpoints sets the Endpoints field's value.

func (*ZookeeperNodeInfo) SetZookeeperId

func (s *ZookeeperNodeInfo) SetZookeeperId(v float64) *ZookeeperNodeInfo

SetZookeeperId sets the ZookeeperId field's value.

func (*ZookeeperNodeInfo) SetZookeeperVersion

func (s *ZookeeperNodeInfo) SetZookeeperVersion(v string) *ZookeeperNodeInfo

SetZookeeperVersion sets the ZookeeperVersion field's value.

func (ZookeeperNodeInfo) String

func (s ZookeeperNodeInfo) String() string

String returns the string representation

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