VpcConnection class

Resource for managing an AWS Managed Streaming for Kafka VPC Connection.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.msk.VpcConnection("test", {
    authentication: "SASL_IAM",
    targetClusterArn: "aws_msk_cluster.arn",
    vpcId: testAwsVpc.id,
    clientSubnets: testAwsSubnet.map(__item => __item.id),
    securityGroups: [testAwsSecurityGroup.id],
});
import pulumi
import pulumi_aws as aws

test = aws.msk.VpcConnection("test",
    authentication="SASL_IAM",
    target_cluster_arn="aws_msk_cluster.arn",
    vpc_id=test_aws_vpc["id"],
    client_subnets=[__item["id"] for __item in test_aws_subnet],
    security_groups=[test_aws_security_group["id"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Msk.VpcConnection("test", new()
    {
        Authentication = "SASL_IAM",
        TargetClusterArn = "aws_msk_cluster.arn",
        VpcId = testAwsVpc.Id,
        ClientSubnets = testAwsSubnet.Select(__item => __item.Id).ToList(),
        SecurityGroups = new[]
        {
            testAwsSecurityGroup.Id,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
var splat0 []interface{}
for _, val0 := range testAwsSubnet {
splat0 = append(splat0, val0.(map[string]interface{})["id"])
}
_, err := msk.NewVpcConnection(ctx, "test", &msk.VpcConnectionArgs{
Authentication: pulumi.String("SASL_IAM"),
TargetClusterArn: pulumi.String("aws_msk_cluster.arn"),
VpcId: pulumi.Any(testAwsVpc.Id),
ClientSubnets: toPulumiArray(splat0),
SecurityGroups: pulumi.StringArray{
testAwsSecurityGroup.Id,
},
})
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_msk_vpcconnection" "test" {
  authentication     = "SASL_IAM"
  target_cluster_arn = "aws_msk_cluster.arn"
  vpc_id             = testAwsVpc.id
  client_subnets     = testAwsSubnet[*].id
  security_groups    = [testAwsSecurityGroup.id]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.VpcConnection;
import com.pulumi.aws.msk.VpcConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new VpcConnection("test", VpcConnectionArgs.builder()
            .authentication("SASL_IAM")
            .targetClusterArn("aws_msk_cluster.arn")
            .vpcId(testAwsVpc.id())
            .clientSubnets(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
            .securityGroups(testAwsSecurityGroup.id())
            .build());

    }
}

Import

Using pulumi import, import MSK configurations using the configuration ARN. For example:

$ pulumi import aws:msk/vpcConnection:VpcConnection example arn:aws:kafka:eu-west-2:123456789012:vpc-connection/123456789012/example/38173259-79cd-4ee8-87f3-682ea6023f48-2

Constructors

VpcConnection(String name, {VpcConnectionArgs? args, CustomResourceOptions? options})
Creates a new VpcConnection. name The Pulumi resource name. args Arguments used to configure this VpcConnection. The set of arguments for VpcConnection. options Resource options controlling this resource's behavior.
VpcConnection.reference(String urn)
Creates a typed reference to an existing VpcConnection resource.

Properties

arn ↔ Output<String>
ARN of the VPC connection.
latefinal
authentication ↔ Output<String>
The authentication type for the client VPC connection. Specify one of these auth type strings: SASL_IAM, SASL_SCRAM, or TLS.
latefinal
childResources → Set<Resource>
finalinherited
clientSubnets ↔ Output<List<String>>
The list of subnets in the client VPC to connect to.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroups ↔ Output<List<String>>
The security groups to attach to the ENIs for the broker nodes.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
targetClusterArn ↔ Output<String>
ARN of the cluster.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
The VPC ID of the remote client.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VpcConnectionState? state, CustomResourceOptions? options}) → VpcConnection
Gets an existing VpcConnection resource's state with the given name and id.