Stage

public struct Stage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Settings for logging access in this stage.

    Declaration

    Swift

    public let accessLogSettings: AccessLogSettings?

  • Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage.

    Declaration

    Swift

    public let apiGatewayManaged: Bool?

  • Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

    Declaration

    Swift

    public let autoDeploy: Bool?

  • The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let clientCertificateId: String?

  • The timestamp when the stage was created.

    Declaration

    Swift

    public let createdDate: TimeStamp?

  • Default route settings for the stage.

    Declaration

    Swift

    public let defaultRouteSettings: RouteSettings?

  • The identifier of the Deployment that the Stage is associated with. Can’t be updated if autoDeploy is enabled.

    Declaration

    Swift

    public let deploymentId: String?

  • The description of the stage.

    Declaration

    Swift

    public let description: String?

  • Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

    Declaration

    Swift

    public let lastDeploymentStatusMessage: String?

  • The timestamp when the stage was last updated.

    Declaration

    Swift

    public let lastUpdatedDate: TimeStamp?

  • Route settings for the stage, by routeKey.

    Declaration

    Swift

    public let routeSettings: [String : RouteSettings]?

  • The name of the stage.

    Declaration

    Swift

    public let stageName: String

  • A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Declaration

    Swift

    public let stageVariables: [String : String]?

  • The collection of tags. Each tag element is associated with a given resource.

    Declaration

    Swift

    public let tags: [String : String]?

  • Undocumented

    Declaration

    Swift

    public init(accessLogSettings: AccessLogSettings? = nil, apiGatewayManaged: Bool? = nil, autoDeploy: Bool? = nil, clientCertificateId: String? = nil, createdDate: TimeStamp? = nil, defaultRouteSettings: RouteSettings? = nil, deploymentId: String? = nil, description: String? = nil, lastDeploymentStatusMessage: String? = nil, lastUpdatedDate: TimeStamp? = nil, routeSettings: [String : RouteSettings]? = nil, stageName: String, stageVariables: [String : String]? = nil, tags: [String : String]? = nil)