Databricks SDK for JavaScript
    Preparing search index...

    Interface AddInstanceProfileRequest

    interface AddInstanceProfileRequest {
        iamRoleArn?: string;
        instanceProfileArn?: string;
        isMetaInstanceProfile?: boolean;
        skipValidation?: boolean;
    }
    Index

    Properties

    iamRoleArn? instanceProfileArn? isMetaInstanceProfile? skipValidation?

    Properties

    iamRoleArn?: string

    The AWS IAM role ARN of the role associated with the instance profile. This field is required if your role name and instance profile name do not match and you want to use the instance profile with Databricks SQL Serverless.

    Otherwise, this field is optional.

    instanceProfileArn?: string

    The AWS ARN of the instance profile to register with . This field is required.

    isMetaInstanceProfile?: boolean

    Boolean flag indicating whether the instance profile should only be used in credential passthrough scenarios. If true, it means the instance profile contains an meta IAM role which could assume a wide range of roles. Therefore it should always be used with authorization. This field is optional, the default value is false.

    skipValidation?: boolean

    By default, validates that it has sufficient permissions to launch instances with the instance profile. This validation uses AWS dry-run mode for the RunInstances API. If validation fails with an error message that does not indicate an IAM related permission issue, (e.g. “Your requested instance type is not supported in your requested availability zone”), you can pass this flag to skip the validation and forcibly add the instance profile.

    Settings

    Member Visibility

    On This Page

    Properties