Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. msk
  5. SingleScramSecretAssociation
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.msk.SingleScramSecretAssociation

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Associates a single SCRAM secret with a Managed Streaming for Kafka (MSK) cluster.

    Example Usage

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

const example = new aws.msk.SingleScramSecretAssociation("example", {
    clusterArn: exampleAwsMskCluster.arn,
    secretArn: exampleAwsSecretsmanagerSecret.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.msk.SingleScramSecretAssociation("example",
    cluster_arn=example_aws_msk_cluster["arn"],
    secret_arn=example_aws_secretsmanager_secret["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := msk.NewSingleScramSecretAssociation(ctx, "example", &msk.SingleScramSecretAssociationArgs{
			ClusterArn: pulumi.Any(exampleAwsMskCluster.Arn),
			SecretArn:  pulumi.Any(exampleAwsSecretsmanagerSecret.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Msk.SingleScramSecretAssociation("example", new()
    {
        ClusterArn = exampleAwsMskCluster.Arn,
        SecretArn = exampleAwsSecretsmanagerSecret.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.SingleScramSecretAssociation;
import com.pulumi.aws.msk.SingleScramSecretAssociationArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new SingleScramSecretAssociation("example", SingleScramSecretAssociationArgs.builder()
            .clusterArn(exampleAwsMskCluster.arn())
            .secretArn(exampleAwsSecretsmanagerSecret.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:msk:SingleScramSecretAssociation
    properties:
      clusterArn: ${exampleAwsMskCluster.arn}
      secretArn: ${exampleAwsSecretsmanagerSecret.arn}

    Create SingleScramSecretAssociation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SingleScramSecretAssociation(name: string, args: SingleScramSecretAssociationArgs, opts?: CustomResourceOptions);
    @overload
def SingleScramSecretAssociation(resource_name: str,
                                 args: SingleScramSecretAssociationArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def SingleScramSecretAssociation(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 cluster_arn: Optional[str] = None,
                                 secret_arn: Optional[str] = None)
    func NewSingleScramSecretAssociation(ctx *Context, name string, args SingleScramSecretAssociationArgs, opts ...ResourceOption) (*SingleScramSecretAssociation, error)
    public SingleScramSecretAssociation(string name, SingleScramSecretAssociationArgs args, CustomResourceOptions? opts = null)
    public SingleScramSecretAssociation(String name, SingleScramSecretAssociationArgs args)
public SingleScramSecretAssociation(String name, SingleScramSecretAssociationArgs args, CustomResourceOptions options)

    type: aws:msk:SingleScramSecretAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SingleScramSecretAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SingleScramSecretAssociationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SingleScramSecretAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SingleScramSecretAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SingleScramSecretAssociationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var singleScramSecretAssociationResource = new Aws.Msk.SingleScramSecretAssociation("singleScramSecretAssociationResource", new()
{
    ClusterArn = "string",
    SecretArn = "string",
});

    example, err := msk.NewSingleScramSecretAssociation(ctx, "singleScramSecretAssociationResource", &msk.SingleScramSecretAssociationArgs{
	ClusterArn: pulumi.String("string"),
	SecretArn:  pulumi.String("string"),
})

    var singleScramSecretAssociationResource = new SingleScramSecretAssociation("singleScramSecretAssociationResource", SingleScramSecretAssociationArgs.builder()
    .clusterArn("string")
    .secretArn("string")
    .build());

    single_scram_secret_association_resource = aws.msk.SingleScramSecretAssociation("singleScramSecretAssociationResource",
    cluster_arn="string",
    secret_arn="string")

    const singleScramSecretAssociationResource = new aws.msk.SingleScramSecretAssociation("singleScramSecretAssociationResource", {
    clusterArn: "string",
    secretArn: "string",
});

    type: aws:msk:SingleScramSecretAssociation
properties:
    clusterArn: string
    secretArn: string

    SingleScramSecretAssociation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SingleScramSecretAssociation resource accepts the following input properties:

    ClusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    SecretArn string
    AWS Secrets Manager secret ARN.
    ClusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    SecretArn string
    AWS Secrets Manager secret ARN.
    clusterArn String
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn String
    AWS Secrets Manager secret ARN.
    clusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn string
    AWS Secrets Manager secret ARN.
    cluster_arn str
    Amazon Resource Name (ARN) of the MSK cluster.
    secret_arn str
    AWS Secrets Manager secret ARN.
    clusterArn String
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn String
    AWS Secrets Manager secret ARN.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SingleScramSecretAssociation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SingleScramSecretAssociation Resource

    Get an existing SingleScramSecretAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SingleScramSecretAssociationState, opts?: CustomResourceOptions): SingleScramSecretAssociation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_arn: Optional[str] = None,
        secret_arn: Optional[str] = None) -> SingleScramSecretAssociation
    func GetSingleScramSecretAssociation(ctx *Context, name string, id IDInput, state *SingleScramSecretAssociationState, opts ...ResourceOption) (*SingleScramSecretAssociation, error)
    public static SingleScramSecretAssociation Get(string name, Input<string> id, SingleScramSecretAssociationState? state, CustomResourceOptions? opts = null)
    public static SingleScramSecretAssociation get(String name, Output<String> id, SingleScramSecretAssociationState state, CustomResourceOptions options)
    resources:  _:    type: aws:msk:SingleScramSecretAssociation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    SecretArn string
    AWS Secrets Manager secret ARN.
    ClusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    SecretArn string
    AWS Secrets Manager secret ARN.
    clusterArn String
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn String
    AWS Secrets Manager secret ARN.
    clusterArn string
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn string
    AWS Secrets Manager secret ARN.
    cluster_arn str
    Amazon Resource Name (ARN) of the MSK cluster.
    secret_arn str
    AWS Secrets Manager secret ARN.
    clusterArn String
    Amazon Resource Name (ARN) of the MSK cluster.
    secretArn String
    AWS Secrets Manager secret ARN.

    Import

    Using pulumi import, import an MSK SCRAM Secret Association using the cluster_arn and secret_arn. For example:

    $ pulumi import aws:msk/singleScramSecretAssociation:SingleScramSecretAssociation example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3,arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws