@cdktf/provider-azurerm
Version:
Prebuilt azurerm Provider for Terraform CDK (cdktf)
254 lines (253 loc) • 12.3 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface PurviewAccountConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#id PurviewAccount#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/purview_account#location PurviewAccount#location}
*/
readonly location: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#managed_resource_group_name PurviewAccount#managed_resource_group_name}
*/
readonly managedResourceGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#name PurviewAccount#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#public_network_enabled PurviewAccount#public_network_enabled}
*/
readonly publicNetworkEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#resource_group_name PurviewAccount#resource_group_name}
*/
readonly resourceGroupName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#tags PurviewAccount#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* identity block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#identity PurviewAccount#identity}
*/
readonly identity: PurviewAccountIdentity;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#timeouts PurviewAccount#timeouts}
*/
readonly timeouts?: PurviewAccountTimeouts;
}
export interface PurviewAccountManagedResources {
}
export declare function purviewAccountManagedResourcesToTerraform(struct?: PurviewAccountManagedResources): any;
export declare function purviewAccountManagedResourcesToHclTerraform(struct?: PurviewAccountManagedResources): any;
export declare class PurviewAccountManagedResourcesOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): PurviewAccountManagedResources | undefined;
set internalValue(value: PurviewAccountManagedResources | undefined);
get eventHubNamespaceId(): string;
get resourceGroupId(): string;
get storageAccountId(): string;
}
export declare class PurviewAccountManagedResourcesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @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): PurviewAccountManagedResourcesOutputReference;
}
export interface PurviewAccountIdentity {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#identity_ids PurviewAccount#identity_ids}
*/
readonly identityIds?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#type PurviewAccount#type}
*/
readonly type: string;
}
export declare function purviewAccountIdentityToTerraform(struct?: PurviewAccountIdentityOutputReference | PurviewAccountIdentity): any;
export declare function purviewAccountIdentityToHclTerraform(struct?: PurviewAccountIdentityOutputReference | PurviewAccountIdentity): any;
export declare class PurviewAccountIdentityOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): PurviewAccountIdentity | undefined;
set internalValue(value: PurviewAccountIdentity | undefined);
private _identityIds?;
get identityIds(): string[];
set identityIds(value: string[]);
resetIdentityIds(): void;
get identityIdsInput(): string[] | undefined;
get principalId(): string;
get tenantId(): string;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
}
export interface PurviewAccountTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#create PurviewAccount#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#delete PurviewAccount#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#read PurviewAccount#read}
*/
readonly read?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#update PurviewAccount#update}
*/
readonly update?: string;
}
export declare function purviewAccountTimeoutsToTerraform(struct?: PurviewAccountTimeouts | cdktf.IResolvable): any;
export declare function purviewAccountTimeoutsToHclTerraform(struct?: PurviewAccountTimeouts | cdktf.IResolvable): any;
export declare class PurviewAccountTimeoutsOutputReference 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(): PurviewAccountTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: PurviewAccountTimeouts | 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/purview_account azurerm_purview_account}
*/
export declare class PurviewAccount extends cdktf.TerraformResource {
static readonly tfResourceType = "azurerm_purview_account";
/**
* Generates CDKTF code for importing a PurviewAccount 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 PurviewAccount to import
* @param importFromId The id of the existing PurviewAccount that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/3.116.0/docs/resources/purview_account#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the PurviewAccount 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/purview_account azurerm_purview_account} 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 PurviewAccountConfig
*/
constructor(scope: Construct, id: string, config: PurviewAccountConfig);
get atlasKafkaEndpointPrimaryConnectionString(): string;
get atlasKafkaEndpointSecondaryConnectionString(): string;
get catalogEndpoint(): string;
get guardianEndpoint(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _location?;
get location(): string;
set location(value: string);
get locationInput(): string | undefined;
private _managedResourceGroupName?;
get managedResourceGroupName(): string;
set managedResourceGroupName(value: string);
resetManagedResourceGroupName(): void;
get managedResourceGroupNameInput(): string | undefined;
private _managedResources;
get managedResources(): PurviewAccountManagedResourcesList;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _publicNetworkEnabled?;
get publicNetworkEnabled(): boolean | cdktf.IResolvable;
set publicNetworkEnabled(value: boolean | cdktf.IResolvable);
resetPublicNetworkEnabled(): void;
get publicNetworkEnabledInput(): boolean | cdktf.IResolvable | undefined;
private _resourceGroupName?;
get resourceGroupName(): string;
set resourceGroupName(value: string);
get resourceGroupNameInput(): string | undefined;
get scanEndpoint(): string;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _identity;
get identity(): PurviewAccountIdentityOutputReference;
putIdentity(value: PurviewAccountIdentity): void;
get identityInput(): PurviewAccountIdentity | undefined;
private _timeouts;
get timeouts(): PurviewAccountTimeoutsOutputReference;
putTimeouts(value: PurviewAccountTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | PurviewAccountTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}