@cdktf/provider-azurerm
Version:
Prebuilt azurerm Provider for Terraform CDK (cdktf)
235 lines (234 loc) • 11.5 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface RoleDefinitionConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#assignable_scopes RoleDefinition#assignable_scopes}
*/
readonly assignableScopes?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#description RoleDefinition#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#id RoleDefinition#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#name RoleDefinition#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#role_definition_id RoleDefinition#role_definition_id}
*/
readonly roleDefinitionId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#scope RoleDefinition#scope}
*/
readonly scope: string;
/**
* permissions block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#permissions RoleDefinition#permissions}
*/
readonly permissions?: RoleDefinitionPermissions[] | cdktf.IResolvable;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#timeouts RoleDefinition#timeouts}
*/
readonly timeouts?: RoleDefinitionTimeouts;
}
export interface RoleDefinitionPermissions {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#actions RoleDefinition#actions}
*/
readonly actions?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#data_actions RoleDefinition#data_actions}
*/
readonly dataActions?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#not_actions RoleDefinition#not_actions}
*/
readonly notActions?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#not_data_actions RoleDefinition#not_data_actions}
*/
readonly notDataActions?: string[];
}
export declare function roleDefinitionPermissionsToTerraform(struct?: RoleDefinitionPermissions | cdktf.IResolvable): any;
export declare function roleDefinitionPermissionsToHclTerraform(struct?: RoleDefinitionPermissions | cdktf.IResolvable): any;
export declare class RoleDefinitionPermissionsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): RoleDefinitionPermissions | cdktf.IResolvable | undefined;
set internalValue(value: RoleDefinitionPermissions | cdktf.IResolvable | undefined);
private _actions?;
get actions(): string[];
set actions(value: string[]);
resetActions(): void;
get actionsInput(): string[] | undefined;
private _dataActions?;
get dataActions(): string[];
set dataActions(value: string[]);
resetDataActions(): void;
get dataActionsInput(): string[] | undefined;
private _notActions?;
get notActions(): string[];
set notActions(value: string[]);
resetNotActions(): void;
get notActionsInput(): string[] | undefined;
private _notDataActions?;
get notDataActions(): string[];
set notDataActions(value: string[]);
resetNotDataActions(): void;
get notDataActionsInput(): string[] | undefined;
}
export declare class RoleDefinitionPermissionsList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: RoleDefinitionPermissions[] | cdktf.IResolvable;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): RoleDefinitionPermissionsOutputReference;
}
export interface RoleDefinitionTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#create RoleDefinition#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#delete RoleDefinition#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#read RoleDefinition#read}
*/
readonly read?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#update RoleDefinition#update}
*/
readonly update?: string;
}
export declare function roleDefinitionTimeoutsToTerraform(struct?: RoleDefinitionTimeouts | cdktf.IResolvable): any;
export declare function roleDefinitionTimeoutsToHclTerraform(struct?: RoleDefinitionTimeouts | cdktf.IResolvable): any;
export declare class RoleDefinitionTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): RoleDefinitionTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: RoleDefinitionTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _read?;
get read(): string;
set read(value: string);
resetRead(): void;
get readInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition azurerm_role_definition}
*/
export declare class RoleDefinition extends cdktf.TerraformResource {
static readonly tfResourceType = "azurerm_role_definition";
/**
* Generates CDKTF code for importing a RoleDefinition resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the RoleDefinition to import
* @param importFromId The id of the existing RoleDefinition that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the RoleDefinition to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/role_definition azurerm_role_definition} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options RoleDefinitionConfig
*/
constructor(scope: Construct, id: string, config: RoleDefinitionConfig);
private _assignableScopes?;
get assignableScopes(): string[];
set assignableScopes(value: string[]);
resetAssignableScopes(): void;
get assignableScopesInput(): string[] | undefined;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _roleDefinitionId?;
get roleDefinitionId(): string;
set roleDefinitionId(value: string);
resetRoleDefinitionId(): void;
get roleDefinitionIdInput(): string | undefined;
get roleDefinitionResourceId(): string;
private _scope?;
get scope(): string;
set scope(value: string);
get scopeInput(): string | undefined;
private _permissions;
get permissions(): RoleDefinitionPermissionsList;
putPermissions(value: RoleDefinitionPermissions[] | cdktf.IResolvable): void;
resetPermissions(): void;
get permissionsInput(): cdktf.IResolvable | RoleDefinitionPermissions[] | undefined;
private _timeouts;
get timeouts(): RoleDefinitionTimeoutsOutputReference;
putTimeouts(value: RoleDefinitionTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | RoleDefinitionTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}