@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
174 lines (173 loc) • 7.83 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface CloudwatchEventRuleConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#description CloudwatchEventRule#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#event_bus_name CloudwatchEventRule#event_bus_name}
*/
readonly eventBusName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#event_pattern CloudwatchEventRule#event_pattern}
*/
readonly eventPattern?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#force_destroy CloudwatchEventRule#force_destroy}
*/
readonly forceDestroy?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#id CloudwatchEventRule#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/5.84.0/docs/resources/cloudwatch_event_rule#is_enabled CloudwatchEventRule#is_enabled}
*/
readonly isEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#name CloudwatchEventRule#name}
*/
readonly name?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#name_prefix CloudwatchEventRule#name_prefix}
*/
readonly namePrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#role_arn CloudwatchEventRule#role_arn}
*/
readonly roleArn?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#schedule_expression CloudwatchEventRule#schedule_expression}
*/
readonly scheduleExpression?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#state CloudwatchEventRule#state}
*/
readonly state?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#tags CloudwatchEventRule#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#tags_all CloudwatchEventRule#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule aws_cloudwatch_event_rule}
*/
export declare class CloudwatchEventRule extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_cloudwatch_event_rule";
/**
* Generates CDKTF code for importing a CloudwatchEventRule 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 CloudwatchEventRule to import
* @param importFromId The id of the existing CloudwatchEventRule that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/cloudwatch_event_rule#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the CloudwatchEventRule 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/5.84.0/docs/resources/cloudwatch_event_rule aws_cloudwatch_event_rule} 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 CloudwatchEventRuleConfig = {}
*/
constructor(scope: Construct, id: string, config?: CloudwatchEventRuleConfig);
get arn(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _eventBusName?;
get eventBusName(): string;
set eventBusName(value: string);
resetEventBusName(): void;
get eventBusNameInput(): string | undefined;
private _eventPattern?;
get eventPattern(): string;
set eventPattern(value: string);
resetEventPattern(): void;
get eventPatternInput(): string | undefined;
private _forceDestroy?;
get forceDestroy(): boolean | cdktf.IResolvable;
set forceDestroy(value: boolean | cdktf.IResolvable);
resetForceDestroy(): void;
get forceDestroyInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _isEnabled?;
get isEnabled(): boolean | cdktf.IResolvable;
set isEnabled(value: boolean | cdktf.IResolvable);
resetIsEnabled(): void;
get isEnabledInput(): boolean | cdktf.IResolvable | undefined;
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _namePrefix?;
get namePrefix(): string;
set namePrefix(value: string);
resetNamePrefix(): void;
get namePrefixInput(): string | undefined;
private _roleArn?;
get roleArn(): string;
set roleArn(value: string);
resetRoleArn(): void;
get roleArnInput(): string | undefined;
private _scheduleExpression?;
get scheduleExpression(): string;
set scheduleExpression(value: string);
resetScheduleExpression(): void;
get scheduleExpressionInput(): string | undefined;
private _state?;
get state(): string;
set state(value: string);
resetState(): void;
get stateInput(): 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;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}