Documentation
¶
Index ¶
- type AddInstanceProfileRequest
- type AddInstanceProfileResponse
- type Client
- func (c *Client) AddInstanceProfile(ctx context.Context, req *AddInstanceProfileRequest, opts ...call.Option) (*AddInstanceProfileResponse, error)
- func (c *Client) EditInstanceProfile(ctx context.Context, req *EditInstanceProfileRequest, opts ...call.Option) (*EditInstanceProfileResponse, error)
- func (c *Client) ListInstanceProfiles(ctx context.Context, req *ListInstanceProfilesRequest, opts ...call.Option) (*ListInstanceProfilesResponse, error)
- func (c *Client) RemoveInstanceProfile(ctx context.Context, req *RemoveInstanceProfileRequest, opts ...call.Option) (*RemoveInstanceProfileResponse, error)
- type EditInstanceProfileRequest
- type EditInstanceProfileResponse
- type InstanceProfile
- type ListInstanceProfilesRequest
- type ListInstanceProfilesResponse
- type RemoveInstanceProfileRequest
- type RemoveInstanceProfileResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddInstanceProfileRequest ¶
type AddInstanceProfileRequest struct {
// By default, <Databricks> 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.
SkipValidation *bool
// The AWS ARN of the instance profile to register with <Databricks>. This field
// is required.
InstanceProfileArn *string
// 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`.
IsMetaInstanceProfile *bool
// 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](/sql/admin/serverless.html).
//
// Otherwise, this field is optional.
IamRoleArn *string
}
type AddInstanceProfileResponse ¶
type AddInstanceProfileResponse struct {
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) AddInstanceProfile ¶
func (c *Client) AddInstanceProfile(ctx context.Context, req *AddInstanceProfileRequest, opts ...call.Option) (*AddInstanceProfileResponse, error)
Registers an instance profile in <Databricks>. In the UI, you can then give users the permission to use this instance profile when launching clusters.
This API is only available to admin users.
func (*Client) EditInstanceProfile ¶
func (c *Client) EditInstanceProfile(ctx context.Context, req *EditInstanceProfileRequest, opts ...call.Option) (*EditInstanceProfileResponse, error)
The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true:
* Your role name and instance profile name do not match. The name is the part after the last slash in each ARN. * You want to use the instance profile with [Databricks SQL Serverless](/sql/admin/serverless.html).
To understand where these fields are in the AWS console, see [Enable serverless SQL warehouses](/sql/admin/serverless.html).
This API is only available to admin users.
func (*Client) ListInstanceProfiles ¶
func (c *Client) ListInstanceProfiles(ctx context.Context, req *ListInstanceProfilesRequest, opts ...call.Option) (*ListInstanceProfilesResponse, error)
List the instance profiles that the calling user can use to launch a cluster.
This API is available to all users.
func (*Client) RemoveInstanceProfile ¶
func (c *Client) RemoveInstanceProfile(ctx context.Context, req *RemoveInstanceProfileRequest, opts ...call.Option) (*RemoveInstanceProfileResponse, error)
Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function.
This API is only accessible to admin users.
type EditInstanceProfileRequest ¶
type EditInstanceProfileRequest struct {
// The AWS ARN of the instance profile to register with <Databricks>. This field
// is required.
InstanceProfileArn *string
// 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`.
IsMetaInstanceProfile *bool
// 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](/sql/admin/serverless.html).
//
// Otherwise, this field is optional.
IamRoleArn *string
}
type EditInstanceProfileResponse ¶
type EditInstanceProfileResponse struct {
}
type InstanceProfile ¶
type InstanceProfile struct {
// The AWS ARN of the instance profile to register with <Databricks>. This field
// is required.
InstanceProfileArn *string
// 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`.
IsMetaInstanceProfile *bool
// 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](/sql/admin/serverless.html).
//
// Otherwise, this field is optional.
IamRoleArn *string
}
type ListInstanceProfilesRequest ¶
type ListInstanceProfilesRequest struct {
}
type ListInstanceProfilesResponse ¶
type ListInstanceProfilesResponse struct {
// A list of instance profiles that the user can access.
InstanceProfiles []InstanceProfile
}
type RemoveInstanceProfileRequest ¶
type RemoveInstanceProfileRequest struct {
// The ARN of the instance profile to remove. This field is required.
InstanceProfileArn *string
}
type RemoveInstanceProfileResponse ¶
type RemoveInstanceProfileResponse struct {
}