// generated from terraform resource schema import { Construct } from 'constructs'; import * as cdktf from 'cdktf'; /** * AWS Amplify */ export interface AmplifyBranchConfig extends cdktf.TerraformMetaArguments { /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#app_id AmplifyBranch#app_id} */ readonly appId: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#backend_environment_arn AmplifyBranch#backend_environment_arn} */ readonly backendEnvironmentArn?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#basic_auth_credentials AmplifyBranch#basic_auth_credentials} */ readonly basicAuthCredentials?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#branch_name AmplifyBranch#branch_name} */ readonly branchName: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#description AmplifyBranch#description} */ readonly description?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#display_name AmplifyBranch#display_name} */ readonly displayName?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#enable_auto_build AmplifyBranch#enable_auto_build} */ readonly enableAutoBuild?: boolean | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#enable_basic_auth AmplifyBranch#enable_basic_auth} */ readonly enableBasicAuth?: boolean | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#enable_notification AmplifyBranch#enable_notification} */ readonly enableNotification?: boolean | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#enable_performance_mode AmplifyBranch#enable_performance_mode} */ readonly enablePerformanceMode?: boolean | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#enable_pull_request_preview AmplifyBranch#enable_pull_request_preview} */ readonly enablePullRequestPreview?: boolean | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#environment_variables AmplifyBranch#environment_variables} */ readonly environmentVariables?: { [key: string]: string } | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#framework AmplifyBranch#framework} */ readonly framework?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#pull_request_environment_name AmplifyBranch#pull_request_environment_name} */ readonly pullRequestEnvironmentName?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#stage AmplifyBranch#stage} */ readonly stage?: string; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#tags AmplifyBranch#tags} */ readonly tags?: { [key: string]: string } | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#tags_all AmplifyBranch#tags_all} */ readonly tagsAll?: { [key: string]: string } | cdktf.IResolvable; /** * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html#ttl AmplifyBranch#ttl} */ readonly ttl?: string; } /** * Represents a {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html aws_amplify_branch} */ export class AmplifyBranch extends cdktf.TerraformResource { // ================= // STATIC PROPERTIES // ================= public static readonly tfResourceType: string = "aws_amplify_branch"; // =========== // INITIALIZER // =========== /** * Create a new {@link https://www.terraform.io/docs/providers/aws/r/amplify_branch.html aws_amplify_branch} 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 AmplifyBranchConfig */ public constructor(scope: Construct, id: string, config: AmplifyBranchConfig) { super(scope, id, { terraformResourceType: 'aws_amplify_branch', terraformGeneratorMetadata: { providerName: 'aws' }, provider: config.provider, dependsOn: config.dependsOn, count: config.count, lifecycle: config.lifecycle }); this._appId = config.appId; this._backendEnvironmentArn = config.backendEnvironmentArn; this._basicAuthCredentials = config.basicAuthCredentials; this._branchName = config.branchName; this._description = config.description; this._displayName = config.displayName; this._enableAutoBuild = config.enableAutoBuild; this._enableBasicAuth = config.enableBasicAuth; this._enableNotification = config.enableNotification; this._enablePerformanceMode = config.enablePerformanceMode; this._enablePullRequestPreview = config.enablePullRequestPreview; this._environmentVariables = config.environmentVariables; this._framework = config.framework; this._pullRequestEnvironmentName = config.pullRequestEnvironmentName; this._stage = config.stage; this._tags = config.tags; this._tagsAll = config.tagsAll; this._ttl = config.ttl; } // ========== // ATTRIBUTES // ========== // app_id - computed: false, optional: false, required: true private _appId?: string; public get appId() { return this.getStringAttribute('app_id'); } public set appId(value: string) { this._appId = value; } // Temporarily expose input value. Use with caution. public get appIdInput() { return this._appId; } // arn - computed: true, optional: false, required: false public get arn() { return this.getStringAttribute('arn'); } // associated_resources - computed: true, optional: false, required: false public get associatedResources() { return this.getListAttribute('associated_resources'); } // backend_environment_arn - computed: false, optional: true, required: false private _backendEnvironmentArn?: string; public get backendEnvironmentArn() { return this.getStringAttribute('backend_environment_arn'); } public set backendEnvironmentArn(value: string) { this._backendEnvironmentArn = value; } public resetBackendEnvironmentArn() { this._backendEnvironmentArn = undefined; } // Temporarily expose input value. Use with caution. public get backendEnvironmentArnInput() { return this._backendEnvironmentArn; } // basic_auth_credentials - computed: false, optional: true, required: false private _basicAuthCredentials?: string; public get basicAuthCredentials() { return this.getStringAttribute('basic_auth_credentials'); } public set basicAuthCredentials(value: string) { this._basicAuthCredentials = value; } public resetBasicAuthCredentials() { this._basicAuthCredentials = undefined; } // Temporarily expose input value. Use with caution. public get basicAuthCredentialsInput() { return this._basicAuthCredentials; } // branch_name - computed: false, optional: false, required: true private _branchName?: string; public get branchName() { return this.getStringAttribute('branch_name'); } public set branchName(value: string) { this._branchName = value; } // Temporarily expose input value. Use with caution. public get branchNameInput() { return this._branchName; } // custom_domains - computed: true, optional: false, required: false public get customDomains() { return this.getListAttribute('custom_domains'); } // description - computed: false, optional: true, required: false private _description?: string; public get description() { return this.getStringAttribute('description'); } public set description(value: string) { this._description = value; } public resetDescription() { this._description = undefined; } // Temporarily expose input value. Use with caution. public get descriptionInput() { return this._description; } // destination_branch - computed: true, optional: false, required: false public get destinationBranch() { return this.getStringAttribute('destination_branch'); } // display_name - computed: true, optional: true, required: false private _displayName?: string; public get displayName() { return this.getStringAttribute('display_name'); } public set displayName(value: string) { this._displayName = value; } public resetDisplayName() { this._displayName = undefined; } // Temporarily expose input value. Use with caution. public get displayNameInput() { return this._displayName; } // enable_auto_build - computed: false, optional: true, required: false private _enableAutoBuild?: boolean | cdktf.IResolvable; public get enableAutoBuild() { return this.getBooleanAttribute('enable_auto_build') as any; } public set enableAutoBuild(value: boolean | cdktf.IResolvable) { this._enableAutoBuild = value; } public resetEnableAutoBuild() { this._enableAutoBuild = undefined; } // Temporarily expose input value. Use with caution. public get enableAutoBuildInput() { return this._enableAutoBuild; } // enable_basic_auth - computed: false, optional: true, required: false private _enableBasicAuth?: boolean | cdktf.IResolvable; public get enableBasicAuth() { return this.getBooleanAttribute('enable_basic_auth') as any; } public set enableBasicAuth(value: boolean | cdktf.IResolvable) { this._enableBasicAuth = value; } public resetEnableBasicAuth() { this._enableBasicAuth = undefined; } // Temporarily expose input value. Use with caution. public get enableBasicAuthInput() { return this._enableBasicAuth; } // enable_notification - computed: false, optional: true, required: false private _enableNotification?: boolean | cdktf.IResolvable; public get enableNotification() { return this.getBooleanAttribute('enable_notification') as any; } public set enableNotification(value: boolean | cdktf.IResolvable) { this._enableNotification = value; } public resetEnableNotification() { this._enableNotification = undefined; } // Temporarily expose input value. Use with caution. public get enableNotificationInput() { return this._enableNotification; } // enable_performance_mode - computed: false, optional: true, required: false private _enablePerformanceMode?: boolean | cdktf.IResolvable; public get enablePerformanceMode() { return this.getBooleanAttribute('enable_performance_mode') as any; } public set enablePerformanceMode(value: boolean | cdktf.IResolvable) { this._enablePerformanceMode = value; } public resetEnablePerformanceMode() { this._enablePerformanceMode = undefined; } // Temporarily expose input value. Use with caution. public get enablePerformanceModeInput() { return this._enablePerformanceMode; } // enable_pull_request_preview - computed: false, optional: true, required: false private _enablePullRequestPreview?: boolean | cdktf.IResolvable; public get enablePullRequestPreview() { return this.getBooleanAttribute('enable_pull_request_preview') as any; } public set enablePullRequestPreview(value: boolean | cdktf.IResolvable) { this._enablePullRequestPreview = value; } public resetEnablePullRequestPreview() { this._enablePullRequestPreview = undefined; } // Temporarily expose input value. Use with caution. public get enablePullRequestPreviewInput() { return this._enablePullRequestPreview; } // environment_variables - computed: false, optional: true, required: false private _environmentVariables?: { [key: string]: string } | cdktf.IResolvable; public get environmentVariables() { // Getting the computed value is not yet implemented return this.interpolationForAttribute('environment_variables') as any; } public set environmentVariables(value: { [key: string]: string } | cdktf.IResolvable) { this._environmentVariables = value; } public resetEnvironmentVariables() { this._environmentVariables = undefined; } // Temporarily expose input value. Use with caution. public get environmentVariablesInput() { return this._environmentVariables; } // framework - computed: false, optional: true, required: false private _framework?: string; public get framework() { return this.getStringAttribute('framework'); } public set framework(value: string) { this._framework = value; } public resetFramework() { this._framework = undefined; } // Temporarily expose input value. Use with caution. public get frameworkInput() { return this._framework; } // id - computed: true, optional: true, required: false public get id() { return this.getStringAttribute('id'); } // pull_request_environment_name - computed: false, optional: true, required: false private _pullRequestEnvironmentName?: string; public get pullRequestEnvironmentName() { return this.getStringAttribute('pull_request_environment_name'); } public set pullRequestEnvironmentName(value: string) { this._pullRequestEnvironmentName = value; } public resetPullRequestEnvironmentName() { this._pullRequestEnvironmentName = undefined; } // Temporarily expose input value. Use with caution. public get pullRequestEnvironmentNameInput() { return this._pullRequestEnvironmentName; } // source_branch - computed: true, optional: false, required: false public get sourceBranch() { return this.getStringAttribute('source_branch'); } // stage - computed: false, optional: true, required: false private _stage?: string; public get stage() { return this.getStringAttribute('stage'); } public set stage(value: string) { this._stage = value; } public resetStage() { this._stage = undefined; } // Temporarily expose input value. Use with caution. public get stageInput() { return this._stage; } // tags - computed: false, optional: true, required: false private _tags?: { [key: string]: string } | cdktf.IResolvable; public get tags() { // Getting the computed value is not yet implemented return this.interpolationForAttribute('tags') as any; } public set tags(value: { [key: string]: string } | cdktf.IResolvable) { this._tags = value; } public resetTags() { this._tags = undefined; } // Temporarily expose input value. Use with caution. public get tagsInput() { return this._tags; } // tags_all - computed: true, optional: true, required: false private _tagsAll?: { [key: string]: string } | cdktf.IResolvable; public get tagsAll() { // Getting the computed value is not yet implemented return this.interpolationForAttribute('tags_all') as any; } public set tagsAll(value: { [key: string]: string } | cdktf.IResolvable) { this._tagsAll = value; } public resetTagsAll() { this._tagsAll = undefined; } // Temporarily expose input value. Use with caution. public get tagsAllInput() { return this._tagsAll; } // ttl - computed: false, optional: true, required: false private _ttl?: string; public get ttl() { return this.getStringAttribute('ttl'); } public set ttl(value: string) { this._ttl = value; } public resetTtl() { this._ttl = undefined; } // Temporarily expose input value. Use with caution. public get ttlInput() { return this._ttl; } // ========= // SYNTHESIS // ========= protected synthesizeAttributes(): { [name: string]: any } { return { app_id: cdktf.stringToTerraform(this._appId), backend_environment_arn: cdktf.stringToTerraform(this._backendEnvironmentArn), basic_auth_credentials: cdktf.stringToTerraform(this._basicAuthCredentials), branch_name: cdktf.stringToTerraform(this._branchName), description: cdktf.stringToTerraform(this._description), display_name: cdktf.stringToTerraform(this._displayName), enable_auto_build: cdktf.booleanToTerraform(this._enableAutoBuild), enable_basic_auth: cdktf.booleanToTerraform(this._enableBasicAuth), enable_notification: cdktf.booleanToTerraform(this._enableNotification), enable_performance_mode: cdktf.booleanToTerraform(this._enablePerformanceMode), enable_pull_request_preview: cdktf.booleanToTerraform(this._enablePullRequestPreview), environment_variables: cdktf.hashMapper(cdktf.anyToTerraform)(this._environmentVariables), framework: cdktf.stringToTerraform(this._framework), pull_request_environment_name: cdktf.stringToTerraform(this._pullRequestEnvironmentName), stage: cdktf.stringToTerraform(this._stage), tags: cdktf.hashMapper(cdktf.anyToTerraform)(this._tags), tags_all: cdktf.hashMapper(cdktf.anyToTerraform)(this._tagsAll), ttl: cdktf.stringToTerraform(this._ttl), }; } }