CreateBranchRequest

public struct CreateBranchRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • The unique ID for an Amplify app.

    Declaration

    Swift

    public let appId: 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 the branch.

    Declaration

    Swift

    public let basicAuthCredentials: String?
  • The name for the branch.

    Declaration

    Swift

    public let branchName: String
  • The build specification (build spec) for the branch.

    Declaration

    Swift

    public let buildSpec: String?
  • The description for the branch.

    Declaration

    Swift

    public let description: String?
  • The display name for a branch. This is used as the default domain prefix.

    Declaration

    Swift

    public let displayName: String?
  • Enables auto building for the branch.

    Declaration

    Swift

    public let enableAutoBuild: Bool?
  • Enables basic authorization for the branch.

    Declaration

    Swift

    public let enableBasicAuth: Bool?
  • Enables notifications for the branch.

    Declaration

    Swift

    public let enableNotification: Bool?
  • Enables pull request preview for this branch.

    Declaration

    Swift

    public let enablePullRequestPreview: Bool?
  • The environment variables for the branch.

    Declaration

    Swift

    public let environmentVariables: [String : String]?
  • The framework for the branch.

    Declaration

    Swift

    public let framework: String?
  • The Amplify environment name for the pull request.

    Declaration

    Swift

    public let pullRequestEnvironmentName: String?
  • Describes the current stage for the branch.

    Declaration

    Swift

    public let stage: Stage?
  • The tag for the branch.

    Declaration

    Swift

    public let tags: [String : String]?
  • ttl

    The content Time To Live (TTL) for the website in seconds.

    Declaration

    Swift

    public let ttl: String?
  • Undocumented

    Declaration

    Swift

    public init(appId: String, backendEnvironmentArn: String? = nil, basicAuthCredentials: String? = nil, branchName: String, buildSpec: String? = nil, description: String? = nil, displayName: String? = nil, enableAutoBuild: Bool? = nil, enableBasicAuth: Bool? = nil, enableNotification: Bool? = nil, enablePullRequestPreview: Bool? = nil, environmentVariables: [String : String]? = nil, framework: String? = nil, pullRequestEnvironmentName: String? = nil, stage: Stage? = nil, tags: [String : String]? = nil, ttl: String? = nil)
  • Declaration

    Swift

    public func validate(name: String) throws