@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
91 lines (90 loc) • 4.77 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface OpensearchserverlessSecurityPolicyConfig extends cdktf.TerraformMetaArguments {
/**
* Description of the policy. Typically used to store information about the permissions defined in the policy.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#description OpensearchserverlessSecurityPolicy#description}
*/
readonly description?: string;
/**
* Name of the policy.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#name OpensearchserverlessSecurityPolicy#name}
*/
readonly name: string;
/**
* JSON policy document to use as the content for the new policy.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#policy OpensearchserverlessSecurityPolicy#policy}
*/
readonly policy: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#region OpensearchserverlessSecurityPolicy#region}
*/
readonly region?: string;
/**
* Type of security policy. One of `encryption` or `network`.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#type OpensearchserverlessSecurityPolicy#type}
*/
readonly type: string;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy aws_opensearchserverless_security_policy}
*/
export declare class OpensearchserverlessSecurityPolicy extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_opensearchserverless_security_policy";
/**
* Generates CDKTF code for importing a OpensearchserverlessSecurityPolicy 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 OpensearchserverlessSecurityPolicy to import
* @param importFromId The id of the existing OpensearchserverlessSecurityPolicy that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/opensearchserverless_security_policy#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the OpensearchserverlessSecurityPolicy 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/aws/6.25.0/docs/resources/opensearchserverless_security_policy aws_opensearchserverless_security_policy} 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 OpensearchserverlessSecurityPolicyConfig
*/
constructor(scope: Construct, id: string, config: OpensearchserverlessSecurityPolicyConfig);
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
get id(): string;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _policy?;
get policy(): string;
set policy(value: string);
get policyInput(): string | undefined;
get policyVersion(): string;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}