@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
189 lines (188 loc) • 9.62 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface StorageObjectAccessControlConfig extends cdktf.TerraformMetaArguments {
/**
* The name of the bucket.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#bucket StorageObjectAccessControl#bucket}
*/
readonly bucket: string;
/**
* The entity holding the permission, in one of the following forms:
* * user-{{userId}}
* * user-{{email}} (such as "user-liz@example.com")
* * group-{{groupId}}
* * group-{{email}} (such as "group-example@googlegroups.com")
* * domain-{{domain}} (such as "domain-example.com")
* * project-team-{{projectId}}
* * allUsers
* * allAuthenticatedUsers
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#entity StorageObjectAccessControl#entity}
*/
readonly entity: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#id StorageObjectAccessControl#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;
/**
* The name of the object to apply the access control to.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#object StorageObjectAccessControl#object}
*/
readonly object: string;
/**
* The access permission for the entity. Possible values: ["OWNER", "READER"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#role StorageObjectAccessControl#role}
*/
readonly role: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#timeouts StorageObjectAccessControl#timeouts}
*/
readonly timeouts?: StorageObjectAccessControlTimeouts;
}
export interface StorageObjectAccessControlProjectTeam {
}
export declare function storageObjectAccessControlProjectTeamToTerraform(struct?: StorageObjectAccessControlProjectTeam): any;
export declare function storageObjectAccessControlProjectTeamToHclTerraform(struct?: StorageObjectAccessControlProjectTeam): any;
export declare class StorageObjectAccessControlProjectTeamOutputReference 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(): StorageObjectAccessControlProjectTeam | undefined;
set internalValue(value: StorageObjectAccessControlProjectTeam | undefined);
get projectNumber(): string;
get team(): string;
}
export declare class StorageObjectAccessControlProjectTeamList 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): StorageObjectAccessControlProjectTeamOutputReference;
}
export interface StorageObjectAccessControlTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#create StorageObjectAccessControl#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#delete StorageObjectAccessControl#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#update StorageObjectAccessControl#update}
*/
readonly update?: string;
}
export declare function storageObjectAccessControlTimeoutsToTerraform(struct?: StorageObjectAccessControlTimeouts | cdktf.IResolvable): any;
export declare function storageObjectAccessControlTimeoutsToHclTerraform(struct?: StorageObjectAccessControlTimeouts | cdktf.IResolvable): any;
export declare class StorageObjectAccessControlTimeoutsOutputReference 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(): StorageObjectAccessControlTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: StorageObjectAccessControlTimeouts | 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 _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control google_storage_object_access_control}
*/
export declare class StorageObjectAccessControl extends cdktf.TerraformResource {
static readonly tfResourceType = "google_storage_object_access_control";
/**
* Generates CDKTF code for importing a StorageObjectAccessControl 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 StorageObjectAccessControl to import
* @param importFromId The id of the existing StorageObjectAccessControl that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/storage_object_access_control#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the StorageObjectAccessControl 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/google/6.13.0/docs/resources/storage_object_access_control google_storage_object_access_control} 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 StorageObjectAccessControlConfig
*/
constructor(scope: Construct, id: string, config: StorageObjectAccessControlConfig);
private _bucket?;
get bucket(): string;
set bucket(value: string);
get bucketInput(): string | undefined;
get domain(): string;
get email(): string;
private _entity?;
get entity(): string;
set entity(value: string);
get entityInput(): string | undefined;
get entityId(): string;
get generation(): number;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _object?;
get object(): string;
set object(value: string);
get objectInput(): string | undefined;
private _projectTeam;
get projectTeam(): StorageObjectAccessControlProjectTeamList;
private _role?;
get role(): string;
set role(value: string);
get roleInput(): string | undefined;
private _timeouts;
get timeouts(): StorageObjectAccessControlTimeoutsOutputReference;
putTimeouts(value: StorageObjectAccessControlTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | StorageObjectAccessControlTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}