1. Packages
  2. Databricks
  3. API Docs
  4. MwsCredentials
Databricks v1.33.1 published on Friday, Feb 23, 2024 by Pulumi

databricks.MwsCredentials

Explore with Pulumi AI

databricks logo
Databricks v1.33.1 published on Friday, Feb 23, 2024 by Pulumi

    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

    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 workspaces in E2 architecture on AWS.

    Create MwsCredentials Resource

    new MwsCredentials(name: string, args: MwsCredentialsArgs, opts?: CustomResourceOptions);
    @overload
    def MwsCredentials(resource_name: 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)
    @overload
    def MwsCredentials(resource_name: str,
                       args: MwsCredentialsArgs,
                       opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args MwsCredentialsArgs
    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 MwsCredentialsArgs
    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 MwsCredentialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MwsCredentialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MwsCredentialsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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:

    CredentialsName string
    RoleArn string
    AccountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    CreationTime int
    (Integer) time of credentials registration
    CredentialsId string
    (String) identifier of credentials
    ExternalId string
    CredentialsName string
    RoleArn string
    AccountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    CreationTime int
    (Integer) time of credentials registration
    CredentialsId string
    (String) identifier of credentials
    ExternalId string
    credentialsName String
    roleArn String
    accountId String

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime Integer
    (Integer) time of credentials registration
    credentialsId String
    (String) identifier of credentials
    externalId String
    credentialsName string
    roleArn string
    accountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime number
    (Integer) time of credentials registration
    credentialsId string
    (String) identifier of credentials
    externalId string
    credentials_name str
    role_arn str
    account_id str

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creation_time int
    (Integer) time of credentials registration
    credentials_id str
    (String) identifier of credentials
    external_id str
    credentialsName String
    roleArn String
    accountId String

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime Number
    (Integer) time of credentials registration
    credentialsId String
    (String) identifier of credentials
    externalId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MwsCredentials 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 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
    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:
    AccountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    CreationTime int
    (Integer) time of credentials registration
    CredentialsId string
    (String) identifier of credentials
    CredentialsName string
    ExternalId string
    RoleArn string
    AccountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    CreationTime int
    (Integer) time of credentials registration
    CredentialsId string
    (String) identifier of credentials
    CredentialsName string
    ExternalId string
    RoleArn string
    accountId String

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime Integer
    (Integer) time of credentials registration
    credentialsId String
    (String) identifier of credentials
    credentialsName String
    externalId String
    roleArn String
    accountId string

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime number
    (Integer) time of credentials registration
    credentialsId string
    (String) identifier of credentials
    credentialsName string
    externalId string
    roleArn string
    account_id str

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creation_time int
    (Integer) time of credentials registration
    credentials_id str
    (String) identifier of credentials
    credentials_name str
    external_id str
    role_arn str
    accountId String

    Deprecated:account_id should be set as part of the Databricks Config, not in the resource.

    creationTime Number
    (Integer) time of credentials registration
    credentialsId String
    (String) identifier of credentials
    credentialsName String
    externalId String
    roleArn String

    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>
    

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.33.1 published on Friday, Feb 23, 2024 by Pulumi