@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
211 lines (210 loc) • 8.99 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface SsmParameterConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#allowed_pattern SsmParameter#allowed_pattern}
*/
readonly allowedPattern?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#arn SsmParameter#arn}
*/
readonly arn?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#data_type SsmParameter#data_type}
*/
readonly dataType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#description SsmParameter#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#id SsmParameter#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/aws/6.25.0/docs/resources/ssm_parameter#insecure_value SsmParameter#insecure_value}
*/
readonly insecureValue?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#key_id SsmParameter#key_id}
*/
readonly keyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#name SsmParameter#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#overwrite SsmParameter#overwrite}
*/
readonly overwrite?: boolean | cdktf.IResolvable;
/**
* 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/ssm_parameter#region SsmParameter#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#tags SsmParameter#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#tags_all SsmParameter#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#tier SsmParameter#tier}
*/
readonly tier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#type SsmParameter#type}
*/
readonly type: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#value SsmParameter#value}
*/
readonly value?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#value_wo SsmParameter#value_wo}
*/
readonly valueWo?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#value_wo_version SsmParameter#value_wo_version}
*/
readonly valueWoVersion?: number;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter aws_ssm_parameter}
*/
export declare class SsmParameter extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_ssm_parameter";
/**
* Generates CDKTF code for importing a SsmParameter 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 SsmParameter to import
* @param importFromId The id of the existing SsmParameter that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ssm_parameter#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the SsmParameter 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/ssm_parameter aws_ssm_parameter} 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 SsmParameterConfig
*/
constructor(scope: Construct, id: string, config: SsmParameterConfig);
private _allowedPattern?;
get allowedPattern(): string;
set allowedPattern(value: string);
resetAllowedPattern(): void;
get allowedPatternInput(): string | undefined;
private _arn?;
get arn(): string;
set arn(value: string);
resetArn(): void;
get arnInput(): string | undefined;
private _dataType?;
get dataType(): string;
set dataType(value: string);
resetDataType(): void;
get dataTypeInput(): string | undefined;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
get hasValueWo(): cdktf.IResolvable;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _insecureValue?;
get insecureValue(): string;
set insecureValue(value: string);
resetInsecureValue(): void;
get insecureValueInput(): string | undefined;
private _keyId?;
get keyId(): string;
set keyId(value: string);
resetKeyId(): void;
get keyIdInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _overwrite?;
get overwrite(): boolean | cdktf.IResolvable;
set overwrite(value: boolean | cdktf.IResolvable);
resetOverwrite(): void;
get overwriteInput(): boolean | cdktf.IResolvable | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll?;
get tagsAll(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
private _tier?;
get tier(): string;
set tier(value: string);
resetTier(): void;
get tierInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
get typeInput(): string | undefined;
private _value?;
get value(): string;
set value(value: string);
resetValue(): void;
get valueInput(): string | undefined;
private _valueWo?;
get valueWo(): string;
set valueWo(value: string);
resetValueWo(): void;
get valueWoInput(): string | undefined;
private _valueWoVersion?;
get valueWoVersion(): number;
set valueWoVersion(value: number);
resetValueWoVersion(): void;
get valueWoVersionInput(): number | undefined;
get version(): number;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}