awskafkaconnect

package
v1.168.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::KafkaConnect Construct Library

This module is part of the AWS Cloud Development Kit project.

import kafkaconnect "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::KafkaConnect.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnConnector_CFN_RESOURCE_TYPE_NAME 

func CfnConnector_CFN_RESOURCE_TYPE_NAME() *string

func CfnConnector_IsCfnElement 

func CfnConnector_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnConnector_IsCfnResource 

func CfnConnector_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnConnector_IsConstruct 

func CfnConnector_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnConnector_Override 

func NewCfnConnector_Override(c CfnConnector, scope awscdk.Construct, id *string, props *CfnConnectorProps)

Create a new `AWS::KafkaConnect::Connector`.

Types

type CfnConnector 

type CfnConnector interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the newly created connector.
	AttrConnectorArn() *string
	// The connector's compute capacity settings.
	Capacity() interface{}
	SetCapacity(val interface{})
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// The configuration of the connector.
	ConnectorConfiguration() interface{}
	SetConnectorConfiguration(val interface{})
	// The description of the connector.
	ConnectorDescription() *string
	SetConnectorDescription(val *string)
	// The name of the connector.
	ConnectorName() *string
	SetConnectorName(val *string)
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The details of the Apache Kafka cluster to which the connector is connected.
	KafkaCluster() interface{}
	SetKafkaCluster(val interface{})
	// The type of client authentication used to connect to the Apache Kafka cluster.
	//
	// The value is NONE when no client authentication is used.
	KafkaClusterClientAuthentication() interface{}
	SetKafkaClusterClientAuthentication(val interface{})
	// Details of encryption in transit to the Apache Kafka cluster.
	KafkaClusterEncryptionInTransit() interface{}
	SetKafkaClusterEncryptionInTransit(val interface{})
	// The version of Kafka Connect.
	//
	// It has to be compatible with both the Apache Kafka cluster's version and the plugins.
	KafkaConnectVersion() *string
	SetKafkaConnectVersion(val *string)
	// The settings for delivering connector logs to Amazon CloudWatch Logs.
	LogDelivery() interface{}
	SetLogDelivery(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Specifies which plugin to use for the connector.
	//
	// You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
	Plugins() interface{}
	SetPlugins(val interface{})
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	// Experimental.
	Ref() *string
	// The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
	ServiceExecutionRoleArn() *string
	SetServiceExecutionRoleArn(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// The worker configurations that are in use with the connector.
	WorkerConfiguration() interface{}
	SetWorkerConfiguration(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::KafkaConnect::Connector`.

Creates a connector using the specified properties.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnConnector := awscdk.Aws_kafkaconnect.NewCfnConnector(this, jsii.String("MyCfnConnector"), &cfnConnectorProps{
	capacity: &capacityProperty{
		autoScaling: &autoScalingProperty{
			maxWorkerCount: jsii.Number(123),
			mcuCount: jsii.Number(123),
			minWorkerCount: jsii.Number(123),
			scaleInPolicy: &scaleInPolicyProperty{
				cpuUtilizationPercentage: jsii.Number(123),
			},
			scaleOutPolicy: &scaleOutPolicyProperty{
				cpuUtilizationPercentage: jsii.Number(123),
			},
		},
		provisionedCapacity: &provisionedCapacityProperty{
			workerCount: jsii.Number(123),

			// the properties below are optional
			mcuCount: jsii.Number(123),
		},
	},
	connectorConfiguration: map[string]*string{
		"connectorConfigurationKey": jsii.String("connectorConfiguration"),
	},
	connectorName: jsii.String("connectorName"),
	kafkaCluster: &kafkaClusterProperty{
		apacheKafkaCluster: &apacheKafkaClusterProperty{
			bootstrapServers: jsii.String("bootstrapServers"),
			vpc: &vpcProperty{
				securityGroups: []*string{
					jsii.String("securityGroups"),
				},
				subnets: []*string{
					jsii.String("subnets"),
				},
			},
		},
	},
	kafkaClusterClientAuthentication: &kafkaClusterClientAuthenticationProperty{
		authenticationType: jsii.String("authenticationType"),
	},
	kafkaClusterEncryptionInTransit: &kafkaClusterEncryptionInTransitProperty{
		encryptionType: jsii.String("encryptionType"),
	},
	kafkaConnectVersion: jsii.String("kafkaConnectVersion"),
	plugins: []interface{}{
		&pluginProperty{
			customPlugin: &customPluginProperty{
				customPluginArn: jsii.String("customPluginArn"),
				revision: jsii.Number(123),
			},
		},
	},
	serviceExecutionRoleArn: jsii.String("serviceExecutionRoleArn"),

	// the properties below are optional
	connectorDescription: jsii.String("connectorDescription"),
	logDelivery: &logDeliveryProperty{
		workerLogDelivery: &workerLogDeliveryProperty{
			cloudWatchLogs: &cloudWatchLogsLogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				logGroup: jsii.String("logGroup"),
			},
			firehose: &firehoseLogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				deliveryStream: jsii.String("deliveryStream"),
			},
			s3: &s3LogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				bucket: jsii.String("bucket"),
				prefix: jsii.String("prefix"),
			},
		},
	},
	workerConfiguration: &workerConfigurationProperty{
		revision: jsii.Number(123),
		workerConfigurationArn: jsii.String("workerConfigurationArn"),
	},
})

func NewCfnConnector 

func NewCfnConnector(scope awscdk.Construct, id *string, props *CfnConnectorProps) CfnConnector

Create a new `AWS::KafkaConnect::Connector`.

type CfnConnectorProps 

type CfnConnectorProps struct {
	// The connector's compute capacity settings.
	Capacity interface{} `field:"required" json:"capacity" yaml:"capacity"`
	// The configuration of the connector.
	ConnectorConfiguration interface{} `field:"required" json:"connectorConfiguration" yaml:"connectorConfiguration"`
	// The name of the connector.
	ConnectorName *string `field:"required" json:"connectorName" yaml:"connectorName"`
	// The details of the Apache Kafka cluster to which the connector is connected.
	KafkaCluster interface{} `field:"required" json:"kafkaCluster" yaml:"kafkaCluster"`
	// The type of client authentication used to connect to the Apache Kafka cluster.
	//
	// The value is NONE when no client authentication is used.
	KafkaClusterClientAuthentication interface{} `field:"required" json:"kafkaClusterClientAuthentication" yaml:"kafkaClusterClientAuthentication"`
	// Details of encryption in transit to the Apache Kafka cluster.
	KafkaClusterEncryptionInTransit interface{} `field:"required" json:"kafkaClusterEncryptionInTransit" yaml:"kafkaClusterEncryptionInTransit"`
	// The version of Kafka Connect.
	//
	// It has to be compatible with both the Apache Kafka cluster's version and the plugins.
	KafkaConnectVersion *string `field:"required" json:"kafkaConnectVersion" yaml:"kafkaConnectVersion"`
	// Specifies which plugin to use for the connector.
	//
	// You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
	Plugins interface{} `field:"required" json:"plugins" yaml:"plugins"`
	// The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
	ServiceExecutionRoleArn *string `field:"required" json:"serviceExecutionRoleArn" yaml:"serviceExecutionRoleArn"`
	// The description of the connector.
	ConnectorDescription *string `field:"optional" json:"connectorDescription" yaml:"connectorDescription"`
	// The settings for delivering connector logs to Amazon CloudWatch Logs.
	LogDelivery interface{} `field:"optional" json:"logDelivery" yaml:"logDelivery"`
	// The worker configurations that are in use with the connector.
	WorkerConfiguration interface{} `field:"optional" json:"workerConfiguration" yaml:"workerConfiguration"`
}

Properties for defining a `CfnConnector`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnConnectorProps := &cfnConnectorProps{
	capacity: &capacityProperty{
		autoScaling: &autoScalingProperty{
			maxWorkerCount: jsii.Number(123),
			mcuCount: jsii.Number(123),
			minWorkerCount: jsii.Number(123),
			scaleInPolicy: &scaleInPolicyProperty{
				cpuUtilizationPercentage: jsii.Number(123),
			},
			scaleOutPolicy: &scaleOutPolicyProperty{
				cpuUtilizationPercentage: jsii.Number(123),
			},
		},
		provisionedCapacity: &provisionedCapacityProperty{
			workerCount: jsii.Number(123),

			// the properties below are optional
			mcuCount: jsii.Number(123),
		},
	},
	connectorConfiguration: map[string]*string{
		"connectorConfigurationKey": jsii.String("connectorConfiguration"),
	},
	connectorName: jsii.String("connectorName"),
	kafkaCluster: &kafkaClusterProperty{
		apacheKafkaCluster: &apacheKafkaClusterProperty{
			bootstrapServers: jsii.String("bootstrapServers"),
			vpc: &vpcProperty{
				securityGroups: []*string{
					jsii.String("securityGroups"),
				},
				subnets: []*string{
					jsii.String("subnets"),
				},
			},
		},
	},
	kafkaClusterClientAuthentication: &kafkaClusterClientAuthenticationProperty{
		authenticationType: jsii.String("authenticationType"),
	},
	kafkaClusterEncryptionInTransit: &kafkaClusterEncryptionInTransitProperty{
		encryptionType: jsii.String("encryptionType"),
	},
	kafkaConnectVersion: jsii.String("kafkaConnectVersion"),
	plugins: []interface{}{
		&pluginProperty{
			customPlugin: &customPluginProperty{
				customPluginArn: jsii.String("customPluginArn"),
				revision: jsii.Number(123),
			},
		},
	},
	serviceExecutionRoleArn: jsii.String("serviceExecutionRoleArn"),

	// the properties below are optional
	connectorDescription: jsii.String("connectorDescription"),
	logDelivery: &logDeliveryProperty{
		workerLogDelivery: &workerLogDeliveryProperty{
			cloudWatchLogs: &cloudWatchLogsLogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				logGroup: jsii.String("logGroup"),
			},
			firehose: &firehoseLogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				deliveryStream: jsii.String("deliveryStream"),
			},
			s3: &s3LogDeliveryProperty{
				enabled: jsii.Boolean(false),

				// the properties below are optional
				bucket: jsii.String("bucket"),
				prefix: jsii.String("prefix"),
			},
		},
	},
	workerConfiguration: &workerConfigurationProperty{
		revision: jsii.Number(123),
		workerConfigurationArn: jsii.String("workerConfigurationArn"),
	},
}

type CfnConnector_ApacheKafkaClusterProperty 

type CfnConnector_ApacheKafkaClusterProperty struct {
	// The bootstrap servers of the cluster.
	BootstrapServers *string `field:"required" json:"bootstrapServers" yaml:"bootstrapServers"`
	// Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
	Vpc interface{} `field:"required" json:"vpc" yaml:"vpc"`
}

The details of the Apache Kafka cluster to which the connector is connected.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

apacheKafkaClusterProperty := &apacheKafkaClusterProperty{
	bootstrapServers: jsii.String("bootstrapServers"),
	vpc: &vpcProperty{
		securityGroups: []*string{
			jsii.String("securityGroups"),
		},
		subnets: []*string{
			jsii.String("subnets"),
		},
	},
}

type CfnConnector_AutoScalingProperty 

type CfnConnector_AutoScalingProperty struct {
	// The maximum number of workers allocated to the connector.
	MaxWorkerCount *float64 `field:"required" json:"maxWorkerCount" yaml:"maxWorkerCount"`
	// The number of microcontroller units (MCUs) allocated to each connector worker.
	//
	// The valid values are 1,2,4,8.
	McuCount *float64 `field:"required" json:"mcuCount" yaml:"mcuCount"`
	// The minimum number of workers allocated to the connector.
	MinWorkerCount *float64 `field:"required" json:"minWorkerCount" yaml:"minWorkerCount"`
	// The sacle-in policy for the connector.
	ScaleInPolicy interface{} `field:"required" json:"scaleInPolicy" yaml:"scaleInPolicy"`
	// The sacle-out policy for the connector.
	ScaleOutPolicy interface{} `field:"required" json:"scaleOutPolicy" yaml:"scaleOutPolicy"`
}

Specifies how the connector scales.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

autoScalingProperty := &autoScalingProperty{
	maxWorkerCount: jsii.Number(123),
	mcuCount: jsii.Number(123),
	minWorkerCount: jsii.Number(123),
	scaleInPolicy: &scaleInPolicyProperty{
		cpuUtilizationPercentage: jsii.Number(123),
	},
	scaleOutPolicy: &scaleOutPolicyProperty{
		cpuUtilizationPercentage: jsii.Number(123),
	},
}

type CfnConnector_CapacityProperty 

type CfnConnector_CapacityProperty struct {
	// Information about the auto scaling parameters for the connector.
	AutoScaling interface{} `field:"optional" json:"autoScaling" yaml:"autoScaling"`
	// Details about a fixed capacity allocated to a connector.
	ProvisionedCapacity interface{} `field:"optional" json:"provisionedCapacity" yaml:"provisionedCapacity"`
}

Information about the capacity of the connector, whether it is auto scaled or provisioned.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

capacityProperty := &capacityProperty{
	autoScaling: &autoScalingProperty{
		maxWorkerCount: jsii.Number(123),
		mcuCount: jsii.Number(123),
		minWorkerCount: jsii.Number(123),
		scaleInPolicy: &scaleInPolicyProperty{
			cpuUtilizationPercentage: jsii.Number(123),
		},
		scaleOutPolicy: &scaleOutPolicyProperty{
			cpuUtilizationPercentage: jsii.Number(123),
		},
	},
	provisionedCapacity: &provisionedCapacityProperty{
		workerCount: jsii.Number(123),

		// the properties below are optional
		mcuCount: jsii.Number(123),
	},
}

type CfnConnector_CloudWatchLogsLogDeliveryProperty 

type CfnConnector_CloudWatchLogsLogDeliveryProperty struct {
	// Whether log delivery to Amazon CloudWatch Logs is enabled.
	Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
	// The name of the CloudWatch log group that is the destination for log delivery.
	LogGroup *string `field:"optional" json:"logGroup" yaml:"logGroup"`
}

The settings for delivering connector logs to Amazon CloudWatch Logs.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cloudWatchLogsLogDeliveryProperty := &cloudWatchLogsLogDeliveryProperty{
	enabled: jsii.Boolean(false),

	// the properties below are optional
	logGroup: jsii.String("logGroup"),
}

type CfnConnector_CustomPluginProperty 

type CfnConnector_CustomPluginProperty struct {
	// The Amazon Resource Name (ARN) of the custom plugin.
	CustomPluginArn *string `field:"required" json:"customPluginArn" yaml:"customPluginArn"`
	// The revision of the custom plugin.
	Revision *float64 `field:"required" json:"revision" yaml:"revision"`
}

A plugin is an AWS resource that contains the code that defines a connector's logic.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

customPluginProperty := &customPluginProperty{
	customPluginArn: jsii.String("customPluginArn"),
	revision: jsii.Number(123),
}

type CfnConnector_FirehoseLogDeliveryProperty 

type CfnConnector_FirehoseLogDeliveryProperty struct {
	// Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
	Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
	// The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
	DeliveryStream *string `field:"optional" json:"deliveryStream" yaml:"deliveryStream"`
}

The settings for delivering logs to Amazon Kinesis Data Firehose.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

firehoseLogDeliveryProperty := &firehoseLogDeliveryProperty{
	enabled: jsii.Boolean(false),

	// the properties below are optional
	deliveryStream: jsii.String("deliveryStream"),
}

type CfnConnector_KafkaClusterClientAuthenticationProperty 

type CfnConnector_KafkaClusterClientAuthenticationProperty struct {
	// The type of client authentication used to connect to the Apache Kafka cluster.
	//
	// Value NONE means that no client authentication is used.
	AuthenticationType *string `field:"required" json:"authenticationType" yaml:"authenticationType"`
}

The client authentication information used in order to authenticate with the Apache Kafka cluster.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

kafkaClusterClientAuthenticationProperty := &kafkaClusterClientAuthenticationProperty{
	authenticationType: jsii.String("authenticationType"),
}

type CfnConnector_KafkaClusterEncryptionInTransitProperty 

type CfnConnector_KafkaClusterEncryptionInTransitProperty struct {
	// The type of encryption in transit to the Apache Kafka cluster.
	EncryptionType *string `field:"required" json:"encryptionType" yaml:"encryptionType"`
}

Details of encryption in transit to the Apache Kafka cluster.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

kafkaClusterEncryptionInTransitProperty := &kafkaClusterEncryptionInTransitProperty{
	encryptionType: jsii.String("encryptionType"),
}

type CfnConnector_KafkaClusterProperty 

type CfnConnector_KafkaClusterProperty struct {
	// The Apache Kafka cluster to which the connector is connected.
	ApacheKafkaCluster interface{} `field:"required" json:"apacheKafkaCluster" yaml:"apacheKafkaCluster"`
}

The details of the Apache Kafka cluster to which the connector is connected.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

kafkaClusterProperty := &kafkaClusterProperty{
	apacheKafkaCluster: &apacheKafkaClusterProperty{
		bootstrapServers: jsii.String("bootstrapServers"),
		vpc: &vpcProperty{
			securityGroups: []*string{
				jsii.String("securityGroups"),
			},
			subnets: []*string{
				jsii.String("subnets"),
			},
		},
	},
}

type CfnConnector_LogDeliveryProperty 

type CfnConnector_LogDeliveryProperty struct {
	// The workers can send worker logs to different destination types.
	//
	// This configuration specifies the details of these destinations.
	WorkerLogDelivery interface{} `field:"required" json:"workerLogDelivery" yaml:"workerLogDelivery"`
}

Details about log delivery.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

logDeliveryProperty := &logDeliveryProperty{
	workerLogDelivery: &workerLogDeliveryProperty{
		cloudWatchLogs: &cloudWatchLogsLogDeliveryProperty{
			enabled: jsii.Boolean(false),

			// the properties below are optional
			logGroup: jsii.String("logGroup"),
		},
		firehose: &firehoseLogDeliveryProperty{
			enabled: jsii.Boolean(false),

			// the properties below are optional
			deliveryStream: jsii.String("deliveryStream"),
		},
		s3: &s3LogDeliveryProperty{
			enabled: jsii.Boolean(false),

			// the properties below are optional
			bucket: jsii.String("bucket"),
			prefix: jsii.String("prefix"),
		},
	},
}

type CfnConnector_PluginProperty 

type CfnConnector_PluginProperty struct {
	// Details about a custom plugin.
	CustomPlugin interface{} `field:"required" json:"customPlugin" yaml:"customPlugin"`
}

A plugin is an AWS resource that contains the code that defines your connector logic.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

pluginProperty := &pluginProperty{
	customPlugin: &customPluginProperty{
		customPluginArn: jsii.String("customPluginArn"),
		revision: jsii.Number(123),
	},
}

type CfnConnector_ProvisionedCapacityProperty 

type CfnConnector_ProvisionedCapacityProperty struct {
	// The number of workers that are allocated to the connector.
	WorkerCount *float64 `field:"required" json:"workerCount" yaml:"workerCount"`
	// The number of microcontroller units (MCUs) allocated to each connector worker.
	//
	// The valid values are 1,2,4,8.
	McuCount *float64 `field:"optional" json:"mcuCount" yaml:"mcuCount"`
}

Details about a connector's provisioned capacity.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

provisionedCapacityProperty := &provisionedCapacityProperty{
	workerCount: jsii.Number(123),

	// the properties below are optional
	mcuCount: jsii.Number(123),
}

type CfnConnector_S3LogDeliveryProperty 

type CfnConnector_S3LogDeliveryProperty struct {
	// Specifies whether connector logs get sent to the specified Amazon S3 destination.
	Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
	// The name of the S3 bucket that is the destination for log delivery.
	Bucket *string `field:"optional" json:"bucket" yaml:"bucket"`
	// The S3 prefix that is the destination for log delivery.
	Prefix *string `field:"optional" json:"prefix" yaml:"prefix"`
}

Details about delivering logs to Amazon S3.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3LogDeliveryProperty := &s3LogDeliveryProperty{
	enabled: jsii.Boolean(false),

	// the properties below are optional
	bucket: jsii.String("bucket"),
	prefix: jsii.String("prefix"),
}

type CfnConnector_ScaleInPolicyProperty 

type CfnConnector_ScaleInPolicyProperty struct {
	// Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
	CpuUtilizationPercentage *float64 `field:"required" json:"cpuUtilizationPercentage" yaml:"cpuUtilizationPercentage"`
}

The scale-in policy for the connector.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

scaleInPolicyProperty := &scaleInPolicyProperty{
	cpuUtilizationPercentage: jsii.Number(123),
}

type CfnConnector_ScaleOutPolicyProperty 

type CfnConnector_ScaleOutPolicyProperty struct {
	// The CPU utilization percentage threshold at which you want connector scale out to be triggered.
	CpuUtilizationPercentage *float64 `field:"required" json:"cpuUtilizationPercentage" yaml:"cpuUtilizationPercentage"`
}

The scale-out policy for the connector.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

scaleOutPolicyProperty := &scaleOutPolicyProperty{
	cpuUtilizationPercentage: jsii.Number(123),
}

type CfnConnector_VpcProperty 

type CfnConnector_VpcProperty struct {
	// The security groups for the connector.
	SecurityGroups *[]*string `field:"required" json:"securityGroups" yaml:"securityGroups"`
	// The subnets for the connector.
	Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}

Information about the VPC in which the connector resides.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcProperty := &vpcProperty{
	securityGroups: []*string{
		jsii.String("securityGroups"),
	},
	subnets: []*string{
		jsii.String("subnets"),
	},
}

type CfnConnector_WorkerConfigurationProperty 

type CfnConnector_WorkerConfigurationProperty struct {
	// The revision of the worker configuration.
	Revision *float64 `field:"required" json:"revision" yaml:"revision"`
	// The Amazon Resource Name (ARN) of the worker configuration.
	WorkerConfigurationArn *string `field:"required" json:"workerConfigurationArn" yaml:"workerConfigurationArn"`
}

The configuration of the workers, which are the processes that run the connector logic.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

workerConfigurationProperty := &workerConfigurationProperty{
	revision: jsii.Number(123),
	workerConfigurationArn: jsii.String("workerConfigurationArn"),
}

type CfnConnector_WorkerLogDeliveryProperty 

type CfnConnector_WorkerLogDeliveryProperty struct {
	// Details about delivering logs to Amazon CloudWatch Logs.
	CloudWatchLogs interface{} `field:"optional" json:"cloudWatchLogs" yaml:"cloudWatchLogs"`
	// Details about delivering logs to Amazon Kinesis Data Firehose.
	Firehose interface{} `field:"optional" json:"firehose" yaml:"firehose"`
	// Details about delivering logs to Amazon S3.
	S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}

Workers can send worker logs to different destination types.

This configuration specifies the details of these destinations.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

workerLogDeliveryProperty := &workerLogDeliveryProperty{
	cloudWatchLogs: &cloudWatchLogsLogDeliveryProperty{
		enabled: jsii.Boolean(false),

		// the properties below are optional
		logGroup: jsii.String("logGroup"),
	},
	firehose: &firehoseLogDeliveryProperty{
		enabled: jsii.Boolean(false),

		// the properties below are optional
		deliveryStream: jsii.String("deliveryStream"),
	},
	s3: &s3LogDeliveryProperty{
		enabled: jsii.Boolean(false),

		// the properties below are optional
		bucket: jsii.String("bucket"),
		prefix: jsii.String("prefix"),
	},
}

Source Files

View all Source files

Directories

Path Synopsis

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.