databricks.MwsCredentials

Note Initialize provider with alias = "mws", host = "https://accounts.cloud.databricks.com" and use provider = databricks.mws

This resource to configure the cross-account role for creation of new workspaces within AWS.

Please follow this complete runnable example Account Id that could be found in the top right corner of Accounts Console

• credentials_name - (Required) name of credentials to register
• role_arn - (Required) ARN of cross-account role

Related Resources

The following resources are used in the same context:

• Provisioning Databricks on AWS guide.
• databricks.MwsCustomerManagedKeys to configure KMS keys for new workspaces within AWS.
• databricks.MwsLogDelivery to configure delivery of billable usage logs and audit logs.
• databricks.MwsNetworks to configure VPC & subnets for new workspaces within AWS.
• databricks.MwsStorageConfigurations to configure root bucket new workspaces within AWS.
• databricks.MwsWorkspaces to set up AWS and GCP workspaces.

Create MwsCredentials Resource

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

Constructor syntax

new MwsCredentials(name: string, args: MwsCredentialsArgs, opts?: CustomResourceOptions);

@overload
def MwsCredentials(resource_name: str,
                   args: MwsCredentialsArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def MwsCredentials(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   credentials_name: Optional[str] = None,
                   role_arn: Optional[str] = None,
                   account_id: Optional[str] = None,
                   creation_time: Optional[int] = None,
                   credentials_id: Optional[str] = None,
                   external_id: Optional[str] = None)

func NewMwsCredentials(ctx *Context, name string, args MwsCredentialsArgs, opts ...ResourceOption) (*MwsCredentials, error)

public MwsCredentials(string name, MwsCredentialsArgs args, CustomResourceOptions? opts = null)

public MwsCredentials(String name, MwsCredentialsArgs args)
public MwsCredentials(String name, MwsCredentialsArgs args, CustomResourceOptions options)

type: databricks:MwsCredentials
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

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

var mwsCredentialsResource = new Databricks.MwsCredentials("mwsCredentialsResource", new()
{
    CredentialsName = "string",
    RoleArn = "string",
    CreationTime = 0,
    CredentialsId = "string",
    ExternalId = "string",
});

example, err := databricks.NewMwsCredentials(ctx, "mwsCredentialsResource", &databricks.MwsCredentialsArgs{
	CredentialsName: pulumi.String("string"),
	RoleArn:         pulumi.String("string"),
	CreationTime:    pulumi.Int(0),
	CredentialsId:   pulumi.String("string"),
	ExternalId:      pulumi.String("string"),
})

var mwsCredentialsResource = new MwsCredentials("mwsCredentialsResource", MwsCredentialsArgs.builder()
    .credentialsName("string")
    .roleArn("string")
    .creationTime(0)
    .credentialsId("string")
    .externalId("string")
    .build());

mws_credentials_resource = databricks.MwsCredentials("mwsCredentialsResource",
    credentials_name="string",
    role_arn="string",
    creation_time=0,
    credentials_id="string",
    external_id="string")

const mwsCredentialsResource = new databricks.MwsCredentials("mwsCredentialsResource", {
    credentialsName: "string",
    roleArn: "string",
    creationTime: 0,
    credentialsId: "string",
    externalId: "string",
});

type: databricks:MwsCredentials
properties:
    creationTime: 0
    credentialsId: string
    credentialsName: string
    externalId: string
    roleArn: string

MwsCredentials Resource Properties

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

Inputs

The MwsCredentials resource accepts the following input properties:

Outputs

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

Look up Existing MwsCredentials Resource

Get an existing MwsCredentials 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?: MwsCredentialsState, opts?: CustomResourceOptions): MwsCredentials

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        creation_time: Optional[int] = None,
        credentials_id: Optional[str] = None,
        credentials_name: Optional[str] = None,
        external_id: Optional[str] = None,
        role_arn: Optional[str] = None) -> MwsCredentials

func GetMwsCredentials(ctx *Context, name string, id IDInput, state *MwsCredentialsState, opts ...ResourceOption) (*MwsCredentials, error)

public static MwsCredentials Get(string name, Input<string> id, MwsCredentialsState? state, CustomResourceOptions? opts = null)

public static MwsCredentials get(String name, Output<String> id, MwsCredentialsState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

Import

This resource can be imported by the combination of its identifier and the account id:

bash

$ pulumi import databricks:index/mwsCredentials:MwsCredentials this <account_id>/<credentials_id>

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

Package Details

Repository

databricks pulumi/pulumi-databricks

License

Apache-2.0

Notes

This Pulumi package is based on the databricks Terraform Provider.