BranchState class

Input properties used for looking up and filtering Branch resources.

Constructors

BranchState({Input<String?>? appId, Input<String?>? arn, Input<List<String>?>? associatedResources, Input<String?>? backendEnvironmentArn, Input<String?>? basicAuthCredentials, Input<String?>? branchName, Input<List<String>?>? customDomains, Input<String?>? description, Input<String?>? destinationBranch, Input<String?>? displayName, Input<bool?>? enableAutoBuild, Input<bool?>? enableBasicAuth, Input<bool?>? enableNotification, Input<bool?>? enablePerformanceMode, Input<bool?>? enablePullRequestPreview, Input<bool?>? enableSkewProtection, Input<Map<String, String>?>? environmentVariables, Input<String?>? framework, Input<String?>? pullRequestEnvironmentName, Input<String?>? region, Input<String?>? sourceBranch, Input<String?>? stage, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? ttl})
Creates a new BranchState. appId Unique ID for an Amplify app. arn ARN for the branch. associatedResources A list of custom resources that are linked to this branch. backendEnvironmentArn ARN for a backend environment that is part of an Amplify app. basicAuthCredentials Basic authorization credentials for the branch. branchName Name for the branch. customDomains Custom domains for the branch. description Description for the branch. destinationBranch Destination branch if the branch is a pull request branch. displayName Display name for a branch. This is used as the default domain prefix. enableAutoBuild Enables auto building for the branch. enableBasicAuth Enables basic authorization for the branch. enableNotification Enables notifications for the branch. enablePerformanceMode Enables performance mode for the branch. enablePullRequestPreview Enables pull request previews for this branch. enableSkewProtection Enables skew protection for the branch. environmentVariables Environment variables for the branch. framework Framework for the branch. pullRequestEnvironmentName Amplify environment name for the pull request. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. sourceBranch Source branch if the branch is a pull request branch. stage Describes the current stage for the branch. Valid values: PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST. tags Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. ttl Content Time To Live (TTL) for the website in seconds.
const
BranchState.fromMap(Map<String, dynamic> map)
factory

Properties

appId → Input<String?>?
Unique ID for an Amplify app.
final
arn → Input<String?>?
ARN for the branch.
final
associatedResources → Input<List<String>?>?
A list of custom resources that are linked to this branch.
final
backendEnvironmentArn → Input<String?>?
ARN for a backend environment that is part of an Amplify app.
final
basicAuthCredentials → Input<String?>?
Basic authorization credentials for the branch.
final
branchName → Input<String?>?
Name for the branch.
final
customDomains → Input<List<String>?>?
Custom domains for the branch.
final
description → Input<String?>?
Description for the branch.
final
destinationBranch → Input<String?>?
Destination branch if the branch is a pull request branch.
final
displayName → Input<String?>?
Display name for a branch. This is used as the default domain prefix.
final
enableAutoBuild → Input<bool?>?
Enables auto building for the branch.
final
enableBasicAuth → Input<bool?>?
Enables basic authorization for the branch.
final
enableNotification → Input<bool?>?
Enables notifications for the branch.
final
enablePerformanceMode → Input<bool?>?
Enables performance mode for the branch.
final
enablePullRequestPreview → Input<bool?>?
Enables pull request previews for this branch.
final
enableSkewProtection → Input<bool?>?
Enables skew protection for the branch.
final
environmentVariables → Input<Map<String, String>?>?
Environment variables for the branch.
final
framework → Input<String?>?
Framework for the branch.
final
hashCode → int
The hash code for this object.
no setterinherited
pullRequestEnvironmentName → Input<String?>?
Amplify environment name for the pull request.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceBranch → Input<String?>?
Source branch if the branch is a pull request branch.
final
stage → Input<String?>?
Describes the current stage for the branch. Valid values: PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST.
final
tags → Input<Map<String, String>?>?
Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
ttl → Input<String?>?
Content Time To Live (TTL) for the website in seconds.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited