BranchState class
Input properties used for looking up and filtering Branch resources.
Constructors
-
BranchState({Input<
String?> ? appId, Input<String?> ? arn, Input<List< ? associatedResources, Input<String> ?>String?> ? backendEnvironmentArn, Input<String?> ? basicAuthCredentials, Input<String?> ? branchName, Input<List< ? customDomains, Input<String> ?>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< ? environmentVariables, Input<String, String> ?>String?> ? framework, Input<String?> ? pullRequestEnvironmentName, Input<String?> ? region, Input<String?> ? sourceBranch, Input<String?> ? stage, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? ttl}) -
Creates a new BranchState.
appIdUnique ID for an Amplify app.arnARN for the branch.associatedResourcesA list of custom resources that are linked to this branch.backendEnvironmentArnARN for a backend environment that is part of an Amplify app.basicAuthCredentialsBasic authorization credentials for the branch.branchNameName for the branch.customDomainsCustom domains for the branch.descriptionDescription for the branch.destinationBranchDestination branch if the branch is a pull request branch.displayNameDisplay name for a branch. This is used as the default domain prefix.enableAutoBuildEnables auto building for the branch.enableBasicAuthEnables basic authorization for the branch.enableNotificationEnables notifications for the branch.enablePerformanceModeEnables performance mode for the branch.enablePullRequestPreviewEnables pull request previews for this branch.enableSkewProtectionEnables skew protection for the branch.environmentVariablesEnvironment variables for the branch.frameworkFramework for the branch.pullRequestEnvironmentNameAmplify environment name for the pull request.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sourceBranchSource branch if the branch is a pull request branch.stageDescribes the current stage for the branch. Valid values:PRODUCTION,BETA,DEVELOPMENT,EXPERIMENTAL,PULL_REQUEST.tagsKey-value mapping of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.ttlContent 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 -
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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