You are viewing an outdated version of provider-aws-kafka.Go to Latest
upbound/provider-aws-kafka@v1.14.0
Cluster
kafka.aws.upbound.io
Cluster
upbound/provider-aws-kafka@v1.14.0kafka.aws.upbound.io

Cluster is the Schema for the Clusters API.

Type

CRD

Group

kafka.aws.upbound.io

Version

apiVersion: kafka.aws.upbound.io/v1beta2

kind: Cluster

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

ClusterSpec defines the desired state of Cluster

forProvider
requiredobject
requiredobject

No description provided.

array

Configuration block for the broker nodes of the Kafka cluster.

array

A list of subnets to connect to in client VPC (documentation).

array

References to Subnet in ec2 to populate clientSubnets.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of Subnet in ec2 to populate clientSubnets.

policy
object
object

Policies for selection.

resolve
string
array

Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible (documentation).

array

Access control settings for brokers. See below.

type
string
array

VPC connectivity access control for brokers. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
boolean
array

A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster.

array

References to SecurityGroup in ec2 to populate securityGroups.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in ec2 to populate securityGroups.

policy
object
object

Policies for selection.

resolve
string
array

A block that contains information about storage volumes attached to MSK broker nodes. See below.

array

A block that contains EBS volume information. See below.

array

A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
array
array

Enables TLS authentication for VPC connectivity.

array

List of ACM Certificate Authority Amazon Resource Names (ARNs).

array

Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.

arn
string
arnRef
object
object

Reference to a Configuration in kafka to populate arn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Configuration in kafka to populate arn.

policy
object
object

Policies for selection.

resolve
string
revision
number
array

Configuration block for specifying encryption. See below.

object

Reference to a Key in kms to populate encryptionAtRestKmsKeyArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate encryptionAtRestKmsKeyArn.

policy
object
object

Policies for selection.

resolve
string
array

Configuration block to specify encryption in transit. See below.

array

Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below.

array

Configuration block for Broker Logs settings for logging info. See below.

array

No description provided.

enabled
boolean
logGroup
string
object

Reference to a Group in cloudwatchlogs to populate logGroup.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Group in cloudwatchlogs to populate logGroup.

policy
object
object

Policies for selection.

resolve
string
array

No description provided.

object

Reference to a DeliveryStream in firehose to populate deliveryStream.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a DeliveryStream in firehose to populate deliveryStream.

policy
object
object

Policies for selection.

resolve
string
enabled
boolean
s3
array
array

No description provided.

bucket
string
bucketRef
object
object

Reference to a Bucket in s3 to populate bucket.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Bucket in s3 to populate bucket.

policy
object
object

Policies for selection.

resolve
string
enabled
boolean
prefix
string
array

Configuration block for JMX and Node monitoring for the MSK cluster. See below.

array

Configuration block for Prometheus settings for open monitoring. See below.

array

Configuration block for JMX Exporter. See below.

array

Configuration block for Node Exporter. See below.

region
requiredstring
tags
object
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

Configuration block for the broker nodes of the Kafka cluster.

array

A list of subnets to connect to in client VPC (documentation).

array

References to Subnet in ec2 to populate clientSubnets.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of Subnet in ec2 to populate clientSubnets.

policy
object
object

Policies for selection.

resolve
string
array

Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible (documentation).

array

Access control settings for brokers. See below.

type
string
array

VPC connectivity access control for brokers. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
boolean
array

A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster.

array

References to SecurityGroup in ec2 to populate securityGroups.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a list of SecurityGroup in ec2 to populate securityGroups.

policy
object
object

Policies for selection.

resolve
string
array

A block that contains information about storage volumes attached to MSK broker nodes. See below.

array

A block that contains EBS volume information. See below.

array

A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
array
array

Enables TLS authentication for VPC connectivity.

array

List of ACM Certificate Authority Amazon Resource Names (ARNs).

array

Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.

arn
string
arnRef
object
object

Reference to a Configuration in kafka to populate arn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Configuration in kafka to populate arn.

policy
object
object

Policies for selection.

resolve
string
revision
number
array

Configuration block for specifying encryption. See below.

object

Reference to a Key in kms to populate encryptionAtRestKmsKeyArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Key in kms to populate encryptionAtRestKmsKeyArn.

policy
object
object

Policies for selection.

resolve
string
array

Configuration block to specify encryption in transit. See below.

array

Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below.

array

Configuration block for Broker Logs settings for logging info. See below.

array

No description provided.

enabled
boolean
logGroup
string
object

Reference to a Group in cloudwatchlogs to populate logGroup.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Group in cloudwatchlogs to populate logGroup.

policy
object
object

Policies for selection.

resolve
string
array

No description provided.

object

Reference to a DeliveryStream in firehose to populate deliveryStream.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a DeliveryStream in firehose to populate deliveryStream.

policy
object
object

Policies for selection.

resolve
string
enabled
boolean
s3
array
array

No description provided.

bucket
string
bucketRef
object
object

Reference to a Bucket in s3 to populate bucket.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Bucket in s3 to populate bucket.

policy
object
object

Policies for selection.

resolve
string
enabled
boolean
prefix
string
array

Configuration block for JMX and Node monitoring for the MSK cluster. See below.

array

Configuration block for Prometheus settings for open monitoring. See below.

array

Configuration block for JMX Exporter. See below.

array

Configuration block for Node Exporter. See below.

tags
object
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

ClusterStatus defines the observed state of Cluster.

object

No description provided.

arn
string
array

Configuration block for the broker nodes of the Kafka cluster.

array

A list of subnets to connect to in client VPC (documentation).

array

Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible (documentation).

array

Access control settings for brokers. See below.

type
string
array

VPC connectivity access control for brokers. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
boolean
array

A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster.

array

A block that contains information about storage volumes attached to MSK broker nodes. See below.

array

A block that contains EBS volume information. See below.

array

A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below.

array

Configuration block for specifying a client authentication. See below.

sasl
array
array

SASL authentication type details for VPC connectivity. See below.

iam
boolean
scram
boolean
tls
array
array

Enables TLS authentication for VPC connectivity.

array

List of ACM Certificate Authority Amazon Resource Names (ARNs).

array

Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below.

arn
string
revision
number
array

Configuration block for specifying encryption. See below.

array

Configuration block to specify encryption in transit. See below.

id
string
array

Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below.

array

Configuration block for Broker Logs settings for logging info. See below.

array

No description provided.

enabled
boolean
logGroup
string
array

No description provided.

s3
array
array

No description provided.

bucket
string
enabled
boolean
prefix
string
array

Configuration block for JMX and Node monitoring for the MSK cluster. See below.

array

Configuration block for Prometheus settings for open monitoring. See below.

array

Configuration block for JMX Exporter. See below.

array

Configuration block for Node Exporter. See below.

tags
object
tagsAll
object
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions