Branch
public struct Branch : AWSShape
Undocumented
-
Declaration
Swift
public static var _members: [AWSShapeMember] -
The ID of the active job for a branch of an Amplify app.
Declaration
Swift
public let activeJobId: String -
A list of custom resources that are linked to this branch.
Declaration
Swift
public let associatedResources: [String]? -
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
Declaration
Swift
public let backendEnvironmentArn: String? -
The basic authorization credentials for a branch of an Amplify app.
Declaration
Swift
public let basicAuthCredentials: String? -
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
Declaration
Swift
public let branchArn: String -
The name for the branch that is part of an Amplify app.
Declaration
Swift
public let branchName: String -
The build specification (build spec) content for the branch of an Amplify app.
Declaration
Swift
public let buildSpec: String? -
The creation date and time for a branch that is part of an Amplify app.
Declaration
Swift
public let createTime: TimeStamp -
The custom domains for a branch of an Amplify app.
Declaration
Swift
public let customDomains: [String] -
The description for the branch that is part of an Amplify app.
Declaration
Swift
public let description: String -
The destination branch if the branch is a pull request branch.
Declaration
Swift
public let destinationBranch: String? -
The display name for the branch. This is used as the default domain prefix.
Declaration
Swift
public let displayName: String -
Enables auto-building on push for a branch of an Amplify app.
Declaration
Swift
public let enableAutoBuild: Bool -
Enables basic authorization for a branch of an Amplify app.
Declaration
Swift
public let enableBasicAuth: Bool -
Enables notifications for a branch that is part of an Amplify app.
Declaration
Swift
public let enableNotification: Bool -
Enables pull request preview for the branch.
Declaration
Swift
public let enablePullRequestPreview: Bool -
The environment variables specific to a branch of an Amplify app.
Declaration
Swift
public let environmentVariables: [String : String] -
The framework for a branch of an Amplify app.
Declaration
Swift
public let framework: String -
The Amplify environment name for the pull request.
Declaration
Swift
public let pullRequestEnvironmentName: String? -
The source branch if the branch is a pull request branch.
Declaration
Swift
public let sourceBranch: String? -
The current stage for the branch that is part of an Amplify app.
Declaration
Swift
public let stage: Stage -
The tag for the branch of an Amplify app.
Declaration
Swift
public let tags: [String : String]? -
The thumbnail URL for the branch of an Amplify app.
Declaration
Swift
public let thumbnailUrl: String? -
The total number of jobs that are part of an Amplify app.
Declaration
Swift
public let totalNumberOfJobs: String -
The content Time to Live (TTL) for the website in seconds.
Declaration
Swift
public let ttl: String -
The last updated date and time for a branch that is part of an Amplify app.
Declaration
Swift
public let updateTime: TimeStamp -
init(activeJobId:associatedResources:backendEnvironmentArn:basicAuthCredentials:branchArn:branchName:buildSpec:createTime:customDomains:description:destinationBranch:displayName:enableAutoBuild:enableBasicAuth:enableNotification:enablePullRequestPreview:environmentVariables:framework:pullRequestEnvironmentName:sourceBranch:stage:tags:thumbnailUrl:totalNumberOfJobs:ttl:updateTime:)Undocumented
Declaration
Swift
public init(activeJobId: String, associatedResources: [String]? = nil, backendEnvironmentArn: String? = nil, basicAuthCredentials: String? = nil, branchArn: String, branchName: String, buildSpec: String? = nil, createTime: TimeStamp, customDomains: [String], description: String, destinationBranch: String? = nil, displayName: String, enableAutoBuild: Bool, enableBasicAuth: Bool, enableNotification: Bool, enablePullRequestPreview: Bool, environmentVariables: [String : String], framework: String, pullRequestEnvironmentName: String? = nil, sourceBranch: String? = nil, stage: Stage, tags: [String : String]? = nil, thumbnailUrl: String? = nil, totalNumberOfJobs: String, ttl: String, updateTime: TimeStamp)
View on GitHub
Branch Structure Reference