SingleScramSecretAssociation class

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"])
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 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 {
		_, err := msk.NewSingleScramSecretAssociation(ctx, "example", &msk.SingleScramSecretAssociationArgs{
			ClusterArn: pulumi.Any(exampleAwsMskCluster.Arn),
			SecretArn:  pulumi.Any(exampleAwsSecretsmanagerSecret.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_msk_singlescramsecretassociation" "example" {
  cluster_arn = exampleAwsMskCluster.arn
  secret_arn  = 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.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 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}

Import

Using pulumi import, import an MSK SCRAM Secret Association using the clusterArn and secretArn. 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

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
clusterArn ↔ Output<String>
ARN of the MSK cluster.
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
secretArn ↔ Output<String>
AWS Secrets Manager secret ARN.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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, {SingleScramSecretAssociationState? state, CustomResourceOptions? options}) → SingleScramSecretAssociation
Gets an existing SingleScramSecretAssociation resource's state with the given name and id.