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
- type BrokerNodeGroupInfo
- func (s BrokerNodeGroupInfo) GoString() string
- func (s *BrokerNodeGroupInfo) SetBrokerAZDistribution(v string) *BrokerNodeGroupInfo
- func (s *BrokerNodeGroupInfo) SetClientSubnets(v []*string) *BrokerNodeGroupInfo
- func (s *BrokerNodeGroupInfo) SetInstanceType(v string) *BrokerNodeGroupInfo
- func (s *BrokerNodeGroupInfo) SetSecurityGroups(v []*string) *BrokerNodeGroupInfo
- func (s *BrokerNodeGroupInfo) SetStorageInfo(v *StorageInfo) *BrokerNodeGroupInfo
- func (s BrokerNodeGroupInfo) String() string
- func (s *BrokerNodeGroupInfo) Validate() error
- type BrokerNodeInfo
- func (s BrokerNodeInfo) GoString() string
- func (s *BrokerNodeInfo) SetAttachedENIId(v string) *BrokerNodeInfo
- func (s *BrokerNodeInfo) SetBrokerId(v float64) *BrokerNodeInfo
- func (s *BrokerNodeInfo) SetClientSubnet(v string) *BrokerNodeInfo
- func (s *BrokerNodeInfo) SetClientVpcIpAddress(v string) *BrokerNodeInfo
- func (s *BrokerNodeInfo) SetCurrentBrokerSoftwareInfo(v *BrokerSoftwareInfo) *BrokerNodeInfo
- func (s BrokerNodeInfo) String() string
- type BrokerSoftwareInfo
- func (s BrokerSoftwareInfo) GoString() string
- func (s *BrokerSoftwareInfo) SetConfigurationArn(v string) *BrokerSoftwareInfo
- func (s *BrokerSoftwareInfo) SetConfigurationRevision(v string) *BrokerSoftwareInfo
- func (s *BrokerSoftwareInfo) SetKafkaVersion(v string) *BrokerSoftwareInfo
- func (s BrokerSoftwareInfo) String() string
- type ClusterInfo
- func (s ClusterInfo) GoString() string
- func (s *ClusterInfo) SetBrokerNodeGroupInfo(v *BrokerNodeGroupInfo) *ClusterInfo
- func (s *ClusterInfo) SetClusterArn(v string) *ClusterInfo
- func (s *ClusterInfo) SetClusterName(v string) *ClusterInfo
- func (s *ClusterInfo) SetCreationTime(v time.Time) *ClusterInfo
- func (s *ClusterInfo) SetCurrentBrokerSoftwareInfo(v *BrokerSoftwareInfo) *ClusterInfo
- func (s *ClusterInfo) SetCurrentVersion(v string) *ClusterInfo
- func (s *ClusterInfo) SetEncryptionInfo(v *EncryptionInfo) *ClusterInfo
- func (s *ClusterInfo) SetEnhancedMonitoring(v string) *ClusterInfo
- func (s *ClusterInfo) SetNumberOfBrokerNodes(v int64) *ClusterInfo
- func (s *ClusterInfo) SetState(v string) *ClusterInfo
- func (s *ClusterInfo) SetZookeeperConnectString(v string) *ClusterInfo
- func (s ClusterInfo) String() string
- type CreateClusterInput
- func (s CreateClusterInput) GoString() string
- func (s *CreateClusterInput) SetBrokerNodeGroupInfo(v *BrokerNodeGroupInfo) *CreateClusterInput
- func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput
- func (s *CreateClusterInput) SetEncryptionInfo(v *EncryptionInfo) *CreateClusterInput
- func (s *CreateClusterInput) SetEnhancedMonitoring(v string) *CreateClusterInput
- func (s *CreateClusterInput) SetKafkaVersion(v string) *CreateClusterInput
- func (s *CreateClusterInput) SetNumberOfBrokerNodes(v int64) *CreateClusterInput
- func (s CreateClusterInput) String() string
- func (s *CreateClusterInput) Validate() error
- type CreateClusterOutput
- func (s CreateClusterOutput) GoString() string
- func (s *CreateClusterOutput) SetClusterArn(v string) *CreateClusterOutput
- func (s *CreateClusterOutput) SetClusterName(v string) *CreateClusterOutput
- func (s *CreateClusterOutput) SetState(v string) *CreateClusterOutput
- func (s CreateClusterOutput) String() string
- type DeleteClusterInput
- type DeleteClusterOutput
- type DescribeClusterInput
- type DescribeClusterOutput
- type EBSStorageInfo
- type EncryptionAtRest
- type EncryptionInfo
- type GetBootstrapBrokersInput
- type GetBootstrapBrokersOutput
- type Kafka
- func (c *Kafka) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
- func (c *Kafka) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
- func (c *Kafka) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)
- func (c *Kafka) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
- func (c *Kafka) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)
- func (c *Kafka) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)
- func (c *Kafka) DescribeCluster(input *DescribeClusterInput) (*DescribeClusterOutput, error)
- func (c *Kafka) DescribeClusterRequest(input *DescribeClusterInput) (req *request.Request, output *DescribeClusterOutput)
- func (c *Kafka) DescribeClusterWithContext(ctx aws.Context, input *DescribeClusterInput, opts ...request.Option) (*DescribeClusterOutput, error)
- func (c *Kafka) GetBootstrapBrokers(input *GetBootstrapBrokersInput) (*GetBootstrapBrokersOutput, error)
- func (c *Kafka) GetBootstrapBrokersRequest(input *GetBootstrapBrokersInput) (req *request.Request, output *GetBootstrapBrokersOutput)
- func (c *Kafka) GetBootstrapBrokersWithContext(ctx aws.Context, input *GetBootstrapBrokersInput, opts ...request.Option) (*GetBootstrapBrokersOutput, error)
- func (c *Kafka) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)
- func (c *Kafka) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)
- func (c *Kafka) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)
- func (c *Kafka) ListNodes(input *ListNodesInput) (*ListNodesOutput, error)
- func (c *Kafka) ListNodesRequest(input *ListNodesInput) (req *request.Request, output *ListNodesOutput)
- func (c *Kafka) ListNodesWithContext(ctx aws.Context, input *ListNodesInput, opts ...request.Option) (*ListNodesOutput, error)
- type ListClustersInput
- func (s ListClustersInput) GoString() string
- func (s *ListClustersInput) SetClusterNameFilter(v string) *ListClustersInput
- func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput
- func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput
- func (s ListClustersInput) String() string
- func (s *ListClustersInput) Validate() error
- type ListClustersOutput
- type ListNodesInput
- func (s ListNodesInput) GoString() string
- func (s *ListNodesInput) SetClusterArn(v string) *ListNodesInput
- func (s *ListNodesInput) SetMaxResults(v int64) *ListNodesInput
- func (s *ListNodesInput) SetNextToken(v string) *ListNodesInput
- func (s ListNodesInput) String() string
- func (s *ListNodesInput) Validate() error
- type ListNodesOutput
- type NodeInfo
- func (s NodeInfo) GoString() string
- func (s *NodeInfo) SetAddedToClusterTime(v string) *NodeInfo
- func (s *NodeInfo) SetBrokerNodeInfo(v *BrokerNodeInfo) *NodeInfo
- func (s *NodeInfo) SetInstanceType(v string) *NodeInfo
- func (s *NodeInfo) SetNodeARN(v string) *NodeInfo
- func (s *NodeInfo) SetNodeType(v string) *NodeInfo
- func (s *NodeInfo) SetZookeeperNodeInfo(v *ZookeeperNodeInfo) *NodeInfo
- func (s NodeInfo) String() string
- type StorageInfo
- type ZookeeperNodeInfo
- func (s ZookeeperNodeInfo) GoString() string
- func (s *ZookeeperNodeInfo) SetAttachedENIId(v string) *ZookeeperNodeInfo
- func (s *ZookeeperNodeInfo) SetClientVpcIpAddress(v string) *ZookeeperNodeInfo
- func (s *ZookeeperNodeInfo) SetZookeeperId(v float64) *ZookeeperNodeInfo
- func (s *ZookeeperNodeInfo) SetZookeeperVersion(v string) *ZookeeperNodeInfo
- func (s ZookeeperNodeInfo) String() string
Constants ¶
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" )
The state of a Kafka cluster.
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" )
Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.
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" // "ServiceUnavailableException". // // Returns information about an error. ErrCodeServiceUnavailableException = "ServiceUnavailableException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // Returns information about an error. ErrCodeTooManyRequestsException = "TooManyRequestsException" // "UnauthorizedException". // // Returns information about an error. ErrCodeUnauthorizedException = "UnauthorizedException" )
const ( ServiceName = "Kafka" // Name of service. EndpointsID = "kafka" // ID to lookup a service endpoint with. ServiceID = "Kafka" // ServiceID is a unique identifer of a specific service. )
Service information constants
const (
// BrokerAZDistributionDefault is a BrokerAZDistribution enum value
BrokerAZDistributionDefault = "DEFAULT"
)
The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among three Availability Zones. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out.
const (
// NodeTypeBroker is a NodeType enum value
NodeTypeBroker = "BROKER"
)
The broker or Zookeeper node.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 Amazon EC2 instances to use for Kafka brokers. The following // instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,kafka.m5.4xlarge, // kafka.m5.12xlarge, and kafka.m5.24xlarge. // // InstanceType is a required field InstanceType *string `locationName:"instanceType" min:"5" type:"string" required:"true"` // The AWS security groups to associate with the elastic network interfaces // in order to specify who can connect to and communicate with the Amazon MSK // cluster. SecurityGroups []*string `locationName:"securityGroups" type:"list"` // Contains information about storage volumes attached to MSK broker nodes. StorageInfo *StorageInfo `locationName:"storageInfo" type:"structure"` // contains filtered or unexported fields }
Describes the setup to be used for Kafka broker nodes in the cluster.
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"` // 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) String ¶
func (s BrokerNodeInfo) String() string
String returns the string representation
type BrokerSoftwareInfo ¶
type BrokerSoftwareInfo struct { // The Amazon Resource Name (ARN) of the configuration used for the cluster. ConfigurationArn *string `locationName:"configurationArn" type:"string"` // The revision of the configuration to use. ConfigurationRevision *string `locationName:"configurationRevision" type:"string"` // The version of Apache Kafka. KafkaVersion *string `locationName:"kafkaVersion" type:"string"` // contains filtered or unexported fields }
Information about the current software installed on the cluster.
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 string) *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 ClusterInfo ¶
type ClusterInfo struct { // Information about the broker nodes. BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" type:"structure"` // The Amazon Resource Name (ARN) that uniquely identifies the cluster. ClusterArn *string `locationName:"clusterArn" type:"string"` // The name of the cluster. ClusterName *string `locationName:"clusterName" type:"string"` // The time when the cluster was created. CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"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. CurrentVersion *string `locationName:"currentVersion" type:"string"` // Includes all encryption-related information. EncryptionInfo *EncryptionInfo `locationName:"encryptionInfo" type:"structure"` // Specifies which metrics are gathered for the MSK cluster. This property has // three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. EnhancedMonitoring *string `locationName:"enhancedMonitoring" type:"string" enum:"EnhancedMonitoring"` // The number of Kafka broker nodes in the cluster. NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" type:"integer"` // The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED. State *string `locationName:"state" type:"string" enum:"ClusterState"` // The connection string to use to connect to the Apache ZooKeeper cluster. ZookeeperConnectString *string `locationName:"zookeeperConnectString" type:"string"` // contains filtered or unexported fields }
Returns information about a cluster.
func (ClusterInfo) GoString ¶
func (s ClusterInfo) GoString() string
GoString returns the string representation
func (*ClusterInfo) SetBrokerNodeGroupInfo ¶
func (s *ClusterInfo) SetBrokerNodeGroupInfo(v *BrokerNodeGroupInfo) *ClusterInfo
SetBrokerNodeGroupInfo sets the BrokerNodeGroupInfo 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) SetNumberOfBrokerNodes ¶
func (s *ClusterInfo) SetNumberOfBrokerNodes(v int64) *ClusterInfo
SetNumberOfBrokerNodes sets the NumberOfBrokerNodes field's value.
func (*ClusterInfo) SetState ¶
func (s *ClusterInfo) SetState(v string) *ClusterInfo
SetState sets the State field's value.
func (*ClusterInfo) SetZookeeperConnectString ¶
func (s *ClusterInfo) SetZookeeperConnectString(v string) *ClusterInfo
SetZookeeperConnectString sets the ZookeeperConnectString field's value.
func (ClusterInfo) String ¶
func (s ClusterInfo) String() string
String returns the string representation
type CreateClusterInput ¶
type CreateClusterInput struct { // Information about the broker nodes in the cluster. // // BrokerNodeGroupInfo is a required field BrokerNodeGroupInfo *BrokerNodeGroupInfo `locationName:"brokerNodeGroupInfo" type:"structure" required:"true"` // The name of the cluster. // // ClusterName is a required field ClusterName *string `locationName:"clusterName" min:"1" type:"string" required:"true"` // Includes all encryption-related information. EncryptionInfo *EncryptionInfo `locationName:"encryptionInfo" type:"structure"` // Specifies the level of monitoring for the MSK cluster. The possible values // are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. EnhancedMonitoring *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"` // The number of Kafka broker nodes in the Amazon MSK cluster. // // NumberOfBrokerNodes is a required field NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" min:"1" type:"integer" required:"true"` // contains filtered or unexported fields }
Creates a cluster.
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) SetClusterName ¶
func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput
SetClusterName sets the ClusterName 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) SetNumberOfBrokerNodes ¶
func (s *CreateClusterInput) SetNumberOfBrokerNodes(v int64) *CreateClusterInput
SetNumberOfBrokerNodes sets the NumberOfBrokerNodes 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 CREATING, ACTIVE, and FAILED. 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 ¶
func (s *CreateClusterOutput) SetState(v string) *CreateClusterOutput
SetState sets the State field's value.
func (CreateClusterOutput) String ¶
func (s CreateClusterOutput) 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 CREATING, ACTIVE, and FAILED. 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 ¶
func (s *DeleteClusterOutput) SetState(v string) *DeleteClusterOutput
SetState sets the State field's value.
func (DeleteClusterOutput) String ¶
func (s DeleteClusterOutput) 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 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 ¶
func (s *DescribeClusterOutput) SetClusterInfo(v *ClusterInfo) *DescribeClusterOutput
SetClusterInfo sets the ClusterInfo field's value.
func (DescribeClusterOutput) String ¶
func (s DescribeClusterOutput) String() string
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 AWS KMS key used for data encryption. // // DataVolumeKMSKeyId is a required field DataVolumeKMSKeyId *string `locationName:"dataVolumeKMSKeyId" type:"string" required:"true"` // contains filtered or unexported fields }
The data volume encryption details.
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 EncryptionInfo ¶
type EncryptionInfo struct { // The data volume encryption details. EncryptionAtRest *EncryptionAtRest `locationName:"encryptionAtRest" type:"structure"` // contains filtered or unexported fields }
Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest.
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) 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 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 ¶
func (s *GetBootstrapBrokersInput) SetClusterArn(v string) *GetBootstrapBrokersInput
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"` // 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) String ¶
func (s GetBootstrapBrokersOutput) String() string
String returns the string representation
type Kafka ¶
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:
// 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) 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 Codes:
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeUnauthorizedException "UnauthorizedException" Returns information about an error.
ErrCodeForbiddenException "ForbiddenException" Returns information about an error.
ErrCodeServiceUnavailableException "ServiceUnavailableException" Returns information about an error.
ErrCodeTooManyRequestsException "TooManyRequestsException" Returns information about an error.
ErrCodeConflictException "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) 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 Codes:
ErrCodeNotFoundException "NotFoundException" Returns information about an error.
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeForbiddenException "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) 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 Codes:
ErrCodeNotFoundException "NotFoundException" Returns information about an error.
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeUnauthorizedException "UnauthorizedException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeForbiddenException "ForbiddenException" Returns information about an error.
See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeCluster
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) 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 Codes:
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeUnauthorizedException "UnauthorizedException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeConflictException "ConflictException" Returns information about an error.
ErrCodeForbiddenException "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) ListClusters ¶
func (c *Kafka) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)
ListClusters API operation for Managed Streaming for Kafka.
Returns a list of clusters in an account.
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 Codes:
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeUnauthorizedException "UnauthorizedException" Returns information about an error.
ErrCodeForbiddenException "ForbiddenException" Returns information about an error.
See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListClusters
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) 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 Codes:
ErrCodeNotFoundException "NotFoundException" Returns information about an error.
ErrCodeBadRequestException "BadRequestException" Returns information about an error.
ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.
ErrCodeForbiddenException "ForbiddenException" Returns information about an error.
See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListNodes
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.
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 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 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) SetAddedToClusterTime ¶
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 ¶
SetInstanceType sets the InstanceType field's value.
func (*NodeInfo) SetNodeARN ¶
SetNodeARN sets the NodeARN field's value.
func (*NodeInfo) SetNodeType ¶
SetNodeType sets the NodeType field's value.
func (*NodeInfo) SetZookeeperNodeInfo ¶
func (s *NodeInfo) SetZookeeperNodeInfo(v *ZookeeperNodeInfo) *NodeInfo
SetZookeeperNodeInfo sets the ZookeeperNodeInfo field's value.
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 ZookeeperNodeInfo ¶
type ZookeeperNodeInfo struct { // The attached elastic network interface of the broker. AttachedENIId *string `locationName:"attachedENIId" type:"string"` // The virtual private cloud (VPC) IP address of the client. ClientVpcIpAddress *string `locationName:"clientVpcIpAddress" type:"string"` // The role-specific ID for Zookeeper. ZookeeperId *float64 `locationName:"zookeeperId" type:"double"` // The version of Zookeeper. ZookeeperVersion *string `locationName:"zookeeperVersion" type:"string"` // contains filtered or unexported fields }
Zookeeper node information.
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) 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. |