types

package
v1.20.3 Latest Latest
Warning

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

 Go to latest Published: May 26, 2023 License: Apache-2.0 Imports: 4 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type BrokerAZDistribution 

type BrokerAZDistribution string
const (
	BrokerAZDistributionDefault BrokerAZDistribution = "DEFAULT"
)

Enum values for BrokerAZDistribution

func (BrokerAZDistribution) Values added in v0.29.0 

func (BrokerAZDistribution) Values() []BrokerAZDistribution

Values returns all known values for BrokerAZDistribution. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BrokerEBSVolumeInfo 

type BrokerEBSVolumeInfo struct {

	// The ID of the broker to update.
	//
	// This member is required.
	KafkaBrokerNodeId *string

	// EBS volume provisioned throughput information.
	ProvisionedThroughput *ProvisionedThroughput

	// Size of the EBS volume to update.
	VolumeSizeGB int32
	// 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.

type BrokerLogs 

type BrokerLogs struct {
	CloudWatchLogs *CloudWatchLogs

	Firehose *Firehose

	S3 *S3
	// contains filtered or unexported fields
}

type BrokerNodeGroupInfo 

type BrokerNodeGroupInfo struct {

	// 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
	// occupy the Availability Zone with ID use use1-az3.
	//
	// This member is required.
	ClientSubnets []string

	// The type of Amazon EC2 instances to use for Apache Kafka brokers. The following
	// instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
	// kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
	//
	// This member is required.
	InstanceType *string

	// The distribution of broker nodes across Availability Zones. This is an optional
	// parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You
	// can also explicitly set this parameter to the value DEFAULT. No other values are
	// currently allowed. Amazon MSK distributes the broker nodes evenly across the
	// Availability Zones that correspond to the subnets you provide when you create
	// the cluster.
	BrokerAZDistribution BrokerAZDistribution

	// Information about the broker access configuration.
	ConnectivityInfo *ConnectivityInfo

	// 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.
	SecurityGroups []string

	// Contains information about storage volumes attached to MSK broker nodes.
	StorageInfo *StorageInfo

	// The list of zoneIds for the cluster in the virtual private cloud (VPC).
	ZoneIds []string
	// contains filtered or unexported fields
}

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

type BrokerNodeInfo 

type BrokerNodeInfo struct {

	// The attached elastic network interface of the broker.
	AttachedENIId *string

	// The ID of the broker.
	BrokerId float64

	// The client subnet to which this broker node belongs.
	ClientSubnet *string

	// The virtual private cloud (VPC) of the client.
	ClientVpcIpAddress *string

	// Information about the version of software currently deployed on the Apache
	// Kafka brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// Endpoints for accessing the broker.
	Endpoints []string
	// contains filtered or unexported fields
}

BrokerNodeInfo

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

	// The revision of the configuration to use. This field isn't visible in this
	// preview release.
	ConfigurationRevision int64

	// The version of Apache Kafka.
	KafkaVersion *string
	// contains filtered or unexported fields
}

Information about the current software installed on the cluster.

type ClientAuthentication 

type ClientAuthentication struct {

	// Details for ClientAuthentication using SASL.
	Sasl *Sasl

	// Details for ClientAuthentication using TLS.
	Tls *Tls

	// Contains information about unauthenticated traffic to the cluster.
	Unauthenticated *Unauthenticated
	// contains filtered or unexported fields
}

Includes all client authentication information.

type ClientBroker 

type ClientBroker string
const (
	ClientBrokerTls          ClientBroker = "TLS"
	ClientBrokerTlsPlaintext ClientBroker = "TLS_PLAINTEXT"
	ClientBrokerPlaintext    ClientBroker = "PLAINTEXT"
)

Enum values for ClientBroker

func (ClientBroker) Values added in v0.29.0 

func (ClientBroker) Values() []ClientBroker

Values returns all known values for ClientBroker. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ClientVpcConnection added in v1.20.0 

type ClientVpcConnection struct {

	// The ARN that identifies the Vpc Connection.
	//
	// This member is required.
	VpcConnectionArn *string

	// Information about the auth scheme of Vpc Connection.
	Authentication *string

	// Creation time of the Vpc Connection.
	CreationTime *time.Time

	// The Owner of the Vpc Connection.
	Owner *string

	// State of the Vpc Connection.
	State VpcConnectionState
	// contains filtered or unexported fields
}

The client VPC connection object.

type CloudWatchLogs 

type CloudWatchLogs struct {

	// This member is required.
	Enabled bool

	LogGroup *string
	// contains filtered or unexported fields
}

type Cluster added in v1.11.0 

type Cluster struct {

	// The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
	ActiveOperationArn *string

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

	// The name of the cluster.
	ClusterName *string

	// Cluster Type.
	ClusterType ClusterType

	// The time when the cluster was created.
	CreationTime *time.Time

	// The current version of the MSK cluster.
	CurrentVersion *string

	// Information about the provisioned cluster.
	Provisioned *Provisioned

	// Information about the serverless cluster.
	Serverless *Serverless

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

	// State Info for the Amazon MSK cluster.
	StateInfo *StateInfo

	// Tags attached to the cluster.
	Tags map[string]string
	// contains filtered or unexported fields
}

Returns information about a cluster.

type ClusterInfo 

type ClusterInfo struct {

	// Arn of active cluster operation.
	ActiveOperationArn *string

	// Information about the broker nodes.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

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

	// The name of the cluster.
	ClusterName *string

	// The time when the cluster was created.
	CreationTime *time.Time

	// Information about the version of software currently deployed on the Apache
	// Kafka brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// The current version of the MSK cluster.
	CurrentVersion *string

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

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

	LoggingInfo *LoggingInfo

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes int32

	// Settings for open monitoring using Prometheus.
	OpenMonitoring *OpenMonitoring

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

	StateInfo *StateInfo

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

	// Tags attached to the cluster.
	Tags map[string]string

	// The connection string to use to connect to the Apache ZooKeeper cluster.
	ZookeeperConnectString *string

	// The connection string to use to connect to zookeeper cluster on Tls port.
	ZookeeperConnectStringTls *string
	// contains filtered or unexported fields
}

Returns information about a cluster.

type ClusterOperationInfo 

type ClusterOperationInfo struct {

	// The ID of the API request that triggered this operation.
	ClientRequestId *string

	// ARN of the cluster.
	ClusterArn *string

	// The time that the operation was created.
	CreationTime *time.Time

	// The time at which the operation finished.
	EndTime *time.Time

	// Describes the error if the operation fails.
	ErrorInfo *ErrorInfo

	// ARN of the cluster operation.
	OperationArn *string

	// State of the cluster operation.
	OperationState *string

	// Steps completed during the operation.
	OperationSteps []ClusterOperationStep

	// Type of the cluster operation.
	OperationType *string

	// Information about cluster attributes before a cluster is updated.
	SourceClusterInfo *MutableClusterInfo

	// Information about cluster attributes after a cluster is updated.
	TargetClusterInfo *MutableClusterInfo

	// Description of the VPC connection for CreateVpcConnection and
	// DeleteVpcConnection operations.
	VpcConnectionInfo *VpcConnectionInfo
	// contains filtered or unexported fields
}

Returns information about a cluster operation.

type ClusterOperationStep 

type ClusterOperationStep struct {

	// Information about the step and its status.
	StepInfo *ClusterOperationStepInfo

	// The name of the step.
	StepName *string
	// contains filtered or unexported fields
}

Step taken during a cluster operation.

type ClusterOperationStepInfo 

type ClusterOperationStepInfo struct {

	// The steps current status.
	StepStatus *string
	// contains filtered or unexported fields
}

State information about the operation step.

type ClusterState 

type ClusterState string
const (
	ClusterStateActive          ClusterState = "ACTIVE"
	ClusterStateCreating        ClusterState = "CREATING"
	ClusterStateDeleting        ClusterState = "DELETING"
	ClusterStateFailed          ClusterState = "FAILED"
	ClusterStateHealing         ClusterState = "HEALING"
	ClusterStateMaintenance     ClusterState = "MAINTENANCE"
	ClusterStateRebootingBroker ClusterState = "REBOOTING_BROKER"
	ClusterStateUpdating        ClusterState = "UPDATING"
)

Enum values for ClusterState

func (ClusterState) Values added in v0.29.0 

func (ClusterState) Values() []ClusterState

Values returns all known values for ClusterState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ClusterType added in v1.11.0 

type ClusterType string
const (
	ClusterTypeProvisioned ClusterType = "PROVISIONED"
	ClusterTypeServerless  ClusterType = "SERVERLESS"
)

Enum values for ClusterType

func (ClusterType) Values added in v1.11.0 

func (ClusterType) Values() []ClusterType

Values returns all known values for ClusterType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CompatibleKafkaVersion 

type CompatibleKafkaVersion struct {

	// An Apache Kafka version.
	SourceVersion *string

	// A list of Apache Kafka versions.
	TargetVersions []string
	// contains filtered or unexported fields
}

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

type Configuration 

type Configuration struct {

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

	// The time when the configuration was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The description of the configuration.
	//
	// This member is required.
	Description *string

	// 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.
	//
	// This member is required.
	KafkaVersions []string

	// Latest revision of the configuration.
	//
	// This member is required.
	LatestRevision *ConfigurationRevision

	// The name of the configuration.
	//
	// This member is required.
	Name *string

	// The state of the configuration. The possible states are ACTIVE, DELETING, and
	// DELETE_FAILED.
	//
	// This member is required.
	State ConfigurationState
	// contains filtered or unexported fields
}

Represents an MSK Configuration.

type ConfigurationInfo 

type ConfigurationInfo struct {

	// ARN of the configuration to use.
	//
	// This member is required.
	Arn *string

	// The revision of the configuration to use.
	//
	// This member is required.
	Revision int64
	// contains filtered or unexported fields
}

Specifies the configuration to use for the brokers.

type ConfigurationRevision 

type ConfigurationRevision struct {

	// The time when the configuration revision was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The revision number.
	//
	// This member is required.
	Revision int64

	// The description of the configuration revision.
	Description *string
	// contains filtered or unexported fields
}

Describes a configuration revision.

type ConfigurationState added in v0.29.0 

type ConfigurationState string
const (
	ConfigurationStateActive       ConfigurationState = "ACTIVE"
	ConfigurationStateDeleting     ConfigurationState = "DELETING"
	ConfigurationStateDeleteFailed ConfigurationState = "DELETE_FAILED"
)

Enum values for ConfigurationState

func (ConfigurationState) Values added in v0.29.0 

func (ConfigurationState) Values() []ConfigurationState

Values returns all known values for ConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConnectivityInfo added in v1.10.0 

type ConnectivityInfo struct {

	// Public access control for brokers.
	PublicAccess *PublicAccess

	// VPC connectivity access control for brokers.
	VpcConnectivity *VpcConnectivity
	// contains filtered or unexported fields
}

Information about the broker access configuration.

type EBSStorageInfo 

type EBSStorageInfo struct {

	// EBS volume provisioned throughput information.
	ProvisionedThroughput *ProvisionedThroughput

	// The size in GiB of the EBS volume for the data drive on each broker node.
	VolumeSize int32
	// contains filtered or unexported fields
}

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

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.
	//
	// This member is required.
	DataVolumeKMSKeyId *string
	// contains filtered or unexported fields
}

The data-volume encryption details.

type EncryptionInTransit 

type EncryptionInTransit struct {

	// Indicates the encryption setting for data in transit between clients and
	// brokers. The following are the possible 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_PLAINTEXT.
	ClientBroker 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
	// contains filtered or unexported fields
}

The settings for encrypting data in transit.

type EncryptionInfo 

type EncryptionInfo struct {

	// The data-volume encryption details.
	EncryptionAtRest *EncryptionAtRest

	// The details for encryption in transit.
	EncryptionInTransit *EncryptionInTransit
	// 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.

type EnhancedMonitoring 

type EnhancedMonitoring string
const (
	EnhancedMonitoringDefault              EnhancedMonitoring = "DEFAULT"
	EnhancedMonitoringPerBroker            EnhancedMonitoring = "PER_BROKER"
	EnhancedMonitoringPerTopicPerBroker    EnhancedMonitoring = "PER_TOPIC_PER_BROKER"
	EnhancedMonitoringPerTopicPerPartition EnhancedMonitoring = "PER_TOPIC_PER_PARTITION"
)

Enum values for EnhancedMonitoring

func (EnhancedMonitoring) Values added in v0.29.0 

func (EnhancedMonitoring) Values() []EnhancedMonitoring

Values returns all known values for EnhancedMonitoring. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ErrorInfo 

type ErrorInfo struct {

	// A number describing the error programmatically.
	ErrorCode *string

	// An optional field to provide more details about the error.
	ErrorString *string
	// contains filtered or unexported fields
}

Returns information about an error state of the cluster.

type Firehose 

type Firehose struct {

	// This member is required.
	Enabled bool

	DeliveryStream *string
	// contains filtered or unexported fields
}

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

type Iam added in v1.3.0 

type Iam struct {

	// Indicates whether IAM access control is enabled.
	Enabled bool
	// contains filtered or unexported fields
}

Details for IAM access control.

type InternalServerErrorException 

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*InternalServerErrorException) Error 

func (e *InternalServerErrorException) Error() string

func (*InternalServerErrorException) ErrorCode 

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault 

func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServerErrorException) ErrorMessage 

func (e *InternalServerErrorException) ErrorMessage() string

type JmxExporter 

type JmxExporter struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	//
	// This member is required.
	EnabledInBroker bool
	// contains filtered or unexported fields
}

Indicates whether you want to turn on or turn off the JMX Exporter.

type JmxExporterInfo 

type JmxExporterInfo struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	//
	// This member is required.
	EnabledInBroker bool
	// contains filtered or unexported fields
}

Indicates whether you want to turn on or turn off the JMX Exporter.

type KafkaVersion 

type KafkaVersion struct {
	Status KafkaVersionStatus

	Version *string
	// contains filtered or unexported fields
}

type KafkaVersionStatus 

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

Enum values for KafkaVersionStatus

func (KafkaVersionStatus) Values added in v0.29.0 

func (KafkaVersionStatus) Values() []KafkaVersionStatus

Values returns all known values for KafkaVersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LoggingInfo 

type LoggingInfo struct {

	// This member is required.
	BrokerLogs *BrokerLogs
	// contains filtered or unexported fields
}

type MutableClusterInfo 

type MutableClusterInfo struct {

	// Specifies the size of the EBS volume and the ID of the associated broker.
	BrokerEBSVolumeInfo []BrokerEBSVolumeInfo

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Information about the changes in the configuration of the brokers.
	ConfigurationInfo *ConfigurationInfo

	// Information about the broker access configuration.
	ConnectivityInfo *ConnectivityInfo

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon
	// CloudWatch for this cluster.
	EnhancedMonitoring EnhancedMonitoring

	// Information about the Amazon MSK broker type.
	InstanceType *string

	// The Apache Kafka version.
	KafkaVersion *string

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

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes int32

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoring

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode
	// contains filtered or unexported fields
}

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

type NodeExporter 

type NodeExporter struct {

	// Indicates whether you want to turn on or turn off the Node Exporter.
	//
	// This member is required.
	EnabledInBroker bool
	// contains filtered or unexported fields
}

Indicates whether you want to turn on or turn off the Node Exporter.

type NodeExporterInfo 

type NodeExporterInfo struct {

	// Indicates whether you want to turn on or turn off the Node Exporter.
	//
	// This member is required.
	EnabledInBroker bool
	// contains filtered or unexported fields
}

Indicates whether you want to turn on or turn off the Node Exporter.

type NodeInfo 

type NodeInfo struct {

	// The start time.
	AddedToClusterTime *string

	// The broker node info.
	BrokerNodeInfo *BrokerNodeInfo

	// The instance type.
	InstanceType *string

	// The Amazon Resource Name (ARN) of the node.
	NodeARN *string

	// The node type.
	NodeType NodeType

	// The ZookeeperNodeInfo.
	ZookeeperNodeInfo *ZookeeperNodeInfo
	// contains filtered or unexported fields
}

The node information object.

type NodeType 

type NodeType string
const (
	NodeTypeBroker NodeType = "BROKER"
)

Enum values for NodeType

func (NodeType) Values added in v0.29.0 

func (NodeType) Values() []NodeType

Values returns all known values for NodeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type OpenMonitoring 

type OpenMonitoring struct {

	// Prometheus settings.
	//
	// This member is required.
	Prometheus *Prometheus
	// contains filtered or unexported fields
}

JMX and Node monitoring for the MSK cluster.

type OpenMonitoringInfo 

type OpenMonitoringInfo struct {

	// Prometheus settings.
	//
	// This member is required.
	Prometheus *PrometheusInfo
	// contains filtered or unexported fields
}

JMX and Node monitoring for the MSK cluster.

type Prometheus 

type Prometheus struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	JmxExporter *JmxExporter

	// Indicates whether you want to turn on or turn off the Node Exporter.
	NodeExporter *NodeExporter
	// contains filtered or unexported fields
}

Prometheus settings.

type PrometheusInfo 

type PrometheusInfo struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	JmxExporter *JmxExporterInfo

	// Indicates whether you want to turn on or turn off the Node Exporter.
	NodeExporter *NodeExporterInfo
	// contains filtered or unexported fields
}

Prometheus settings.

type Provisioned added in v1.11.0 

type Provisioned struct {

	// Information about the brokers.
	//
	// This member is required.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo

	// The number of broker nodes in the cluster.
	//
	// This member is required.
	NumberOfBrokerNodes int32

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Information about the Apache Kafka version deployed on the brokers.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// Specifies the level of monitoring for the MSK cluster. The possible values are
	// DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
	EnhancedMonitoring EnhancedMonitoring

	// Log delivery information for the cluster.
	LoggingInfo *LoggingInfo

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo

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

	// The connection string to use to connect to the Apache ZooKeeper cluster.
	ZookeeperConnectString *string

	// The connection string to use to connect to the Apache ZooKeeper cluster on a
	// TLS port.
	ZookeeperConnectStringTls *string
	// contains filtered or unexported fields
}

Provisioned cluster.

type ProvisionedRequest added in v1.11.0 

type ProvisionedRequest struct {

	// Information about the brokers.
	//
	// This member is required.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo

	// The Apache Kafka version that you want for the cluster.
	//
	// This member is required.
	KafkaVersion *string

	// The number of broker nodes in the cluster.
	//
	// This member is required.
	NumberOfBrokerNodes int32

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Represents the configuration that you want Amazon MSK to use for the brokers in
	// a cluster.
	ConfigurationInfo *ConfigurationInfo

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// Specifies the level of monitoring for the MSK cluster. The possible values are
	// DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
	EnhancedMonitoring EnhancedMonitoring

	// Log delivery information for the cluster.
	LoggingInfo *LoggingInfo

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode
	// contains filtered or unexported fields
}

Provisioned cluster request.

type ProvisionedThroughput added in v1.16.0 

type ProvisionedThroughput struct {

	// Provisioned throughput is enabled or not.
	Enabled bool

	// Throughput value of the EBS volumes for the data drive on each kafka broker
	// node in MiB per second.
	VolumeThroughput int32
	// contains filtered or unexported fields
}

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

type PublicAccess added in v1.10.0 

type PublicAccess struct {

	// The value DISABLED indicates that public access is turned off.
	// SERVICE_PROVIDED_EIPS indicates that public access is turned on.
	Type *string
	// contains filtered or unexported fields
}

Public access control for brokers.

type S3 

type S3 struct {

	// This member is required.
	Enabled bool

	Bucket *string

	Prefix *string
	// contains filtered or unexported fields
}

type Sasl added in v0.29.0 

type Sasl struct {

	// Indicates whether IAM access control is enabled.
	Iam *Iam

	// Details for SASL/SCRAM client authentication.
	Scram *Scram
	// contains filtered or unexported fields
}

Details for client authentication using SASL.

type Scram added in v0.29.0 

type Scram struct {

	// SASL/SCRAM authentication is enabled or not.
	Enabled bool
	// contains filtered or unexported fields
}

Details for SASL/SCRAM client authentication.

type Serverless added in v1.11.0 

type Serverless struct {

	// The configuration of the Amazon VPCs for the cluster.
	//
	// This member is required.
	VpcConfigs []VpcConfig

	// Includes all client authentication information.
	ClientAuthentication *ServerlessClientAuthentication
	// contains filtered or unexported fields
}

Serverless cluster.

type ServerlessClientAuthentication added in v1.11.0 

type ServerlessClientAuthentication struct {

	// Details for ClientAuthentication using SASL.
	Sasl *ServerlessSasl
	// contains filtered or unexported fields
}

Includes all client authentication information.

type ServerlessRequest added in v1.11.0 

type ServerlessRequest struct {

	// The configuration of the Amazon VPCs for the cluster.
	//
	// This member is required.
	VpcConfigs []VpcConfig

	// Includes all client authentication information.
	ClientAuthentication *ServerlessClientAuthentication
	// contains filtered or unexported fields
}

Serverless cluster request.

type ServerlessSasl added in v1.11.0 

type ServerlessSasl struct {

	// Indicates whether IAM access control is enabled.
	Iam *Iam
	// contains filtered or unexported fields
}

Details for client authentication using SASL.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type StateInfo 

type StateInfo struct {
	Code *string

	Message *string
	// contains filtered or unexported fields
}

type StorageInfo 

type StorageInfo struct {

	// EBS volume information.
	EbsStorageInfo *EBSStorageInfo
	// contains filtered or unexported fields
}

Contains information about storage volumes attached to MSK broker nodes.

type StorageMode added in v1.18.0 

type StorageMode string
const (
	StorageModeLocal  StorageMode = "LOCAL"
	StorageModeTiered StorageMode = "TIERED"
)

Enum values for StorageMode

func (StorageMode) Values added in v1.18.0 

func (StorageMode) Values() []StorageMode

Values returns all known values for StorageMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Tls 

type Tls struct {

	// List of ACM Certificate Authority ARNs.
	CertificateAuthorityArnList []string

	// Specifies whether you want to turn on or turn off TLS authentication.
	Enabled bool
	// contains filtered or unexported fields
}

Details for client authentication using TLS.

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type Unauthenticated added in v1.7.0 

type Unauthenticated struct {

	// Specifies whether you want to turn on or turn off unauthenticated traffic to
	// your cluster.
	Enabled bool
	// contains filtered or unexported fields
}

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidParameter *string
	// contains filtered or unexported fields
}

Returns information about an error.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UnprocessedScramSecret added in v0.29.0 

type UnprocessedScramSecret struct {

	// Error code for associate/disassociate failure.
	ErrorCode *string

	// Error message for associate/disassociate failure.
	ErrorMessage *string

	// AWS Secrets Manager secret ARN.
	SecretArn *string
	// contains filtered or unexported fields
}

Error info for scram secret associate/disassociate failure.

type UserIdentity added in v1.20.0 

type UserIdentity struct {

	// A unique identifier for the requester that calls the API operation.
	PrincipalId *string

	// The identity type of the requester that calls the API operation.
	Type UserIdentityType
	// contains filtered or unexported fields
}

Description of the requester that calls the API operation.

type UserIdentityType added in v1.20.0 

type UserIdentityType string
const (
	UserIdentityTypeAwsaccount UserIdentityType = "AWSACCOUNT"
	UserIdentityTypeAwsservice UserIdentityType = "AWSSERVICE"
)

Enum values for UserIdentityType

func (UserIdentityType) Values added in v1.20.0 

func (UserIdentityType) Values() []UserIdentityType

Values returns all known values for UserIdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VpcConfig added in v1.11.0 

type VpcConfig struct {

	// The IDs of the subnets associated with the cluster.
	//
	// This member is required.
	SubnetIds []string

	// The IDs of the security groups associated with the cluster.
	SecurityGroupIds []string
	// contains filtered or unexported fields
}

The configuration of the Amazon VPCs for the cluster.

type VpcConnection added in v1.20.0 

type VpcConnection struct {

	// The ARN that identifies the Cluster which the Vpc Connection belongs to.
	//
	// This member is required.
	TargetClusterArn *string

	// The ARN that identifies the Vpc Connection.
	//
	// This member is required.
	VpcConnectionArn *string

	// Information about the auth scheme of Vpc Connection.
	Authentication *string

	// Creation time of the Vpc Connection.
	CreationTime *time.Time

	// State of the Vpc Connection.
	State VpcConnectionState

	// The vpcId that belongs to the Vpc Connection.
	VpcId *string
	// contains filtered or unexported fields
}

The VPC connection object.

type VpcConnectionInfo added in v1.20.0 

type VpcConnectionInfo struct {

	// The time when Amazon MSK creates the VPC Connnection.
	CreationTime *time.Time

	// The owner of the VPC Connection.
	Owner *string

	// Description of the requester that calls the API operation.
	UserIdentity *UserIdentity

	// The Amazon Resource Name (ARN) of the VPC connection.
	VpcConnectionArn *string
	// contains filtered or unexported fields
}

Description of the VPC connection.

type VpcConnectionState added in v1.20.0 

type VpcConnectionState string
const (
	VpcConnectionStateCreating     VpcConnectionState = "CREATING"
	VpcConnectionStateAvailable    VpcConnectionState = "AVAILABLE"
	VpcConnectionStateInactive     VpcConnectionState = "INACTIVE"
	VpcConnectionStateDeactivating VpcConnectionState = "DEACTIVATING"
	VpcConnectionStateDeleting     VpcConnectionState = "DELETING"
	VpcConnectionStateFailed       VpcConnectionState = "FAILED"
	VpcConnectionStateRejected     VpcConnectionState = "REJECTED"
	VpcConnectionStateRejecting    VpcConnectionState = "REJECTING"
)

Enum values for VpcConnectionState

func (VpcConnectionState) Values added in v1.20.0 

func (VpcConnectionState) Values() []VpcConnectionState

Values returns all known values for VpcConnectionState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VpcConnectivity added in v1.20.0 

type VpcConnectivity struct {

	// Includes all client authentication information for VPC connectivity.
	ClientAuthentication *VpcConnectivityClientAuthentication
	// contains filtered or unexported fields
}

VPC connectivity access control for brokers.

type VpcConnectivityClientAuthentication added in v1.20.0 

type VpcConnectivityClientAuthentication struct {

	// SASL authentication type details for VPC connectivity.
	Sasl *VpcConnectivitySasl

	// TLS authentication type details for VPC connectivity.
	Tls *VpcConnectivityTls
	// contains filtered or unexported fields
}

Includes all client authentication information for VPC connectivity.

type VpcConnectivityIam added in v1.20.0 

type VpcConnectivityIam struct {

	// SASL/IAM authentication is on or off for VPC connectivity.
	Enabled bool
	// contains filtered or unexported fields
}

Details for IAM access control for VPC connectivity.

type VpcConnectivitySasl added in v1.20.0 

type VpcConnectivitySasl struct {

	// Details for SASL/IAM client authentication for VPC connectivity.
	Iam *VpcConnectivityIam

	// Details for SASL/SCRAM client authentication for VPC connectivity.
	Scram *VpcConnectivityScram
	// contains filtered or unexported fields
}

Details for SASL client authentication for VPC connectivity.

type VpcConnectivityScram added in v1.20.0 

type VpcConnectivityScram struct {

	// SASL/SCRAM authentication is on or off for VPC connectivity.
	Enabled bool
	// contains filtered or unexported fields
}

Details for SASL/SCRAM client authentication for VPC connectivity.

type VpcConnectivityTls added in v1.20.0 

type VpcConnectivityTls struct {

	// TLS authentication is on or off for VPC connectivity.
	Enabled bool
	// contains filtered or unexported fields
}

Details for TLS client authentication for VPC connectivity.

type ZookeeperNodeInfo 

type ZookeeperNodeInfo struct {

	// The attached elastic network interface of the broker.
	AttachedENIId *string

	// The virtual private cloud (VPC) IP address of the client.
	ClientVpcIpAddress *string

	// Endpoints for accessing the ZooKeeper.
	Endpoints []string

	// The role-specific ID for Zookeeper.
	ZookeeperId float64

	// The version of Zookeeper.
	ZookeeperVersion *string
	// contains filtered or unexported fields
}

Zookeeper node information.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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