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 cache cluster is enabled for the stage.

    Declaration

    Swift

    public let cacheClusterEnabled: Bool?

  • The size of the cache cluster for the stage, if enabled.

    Declaration

    Swift

    public let cacheClusterSize: CacheClusterSize?

  • The status of the cache cluster for the stage, if enabled.

    Declaration

    Swift

    public let cacheClusterStatus: CacheClusterStatus?

  • Settings for the canary deployment in this stage.

    Declaration

    Swift

    public let canarySettings: CanarySettings?

  • The identifier of a client certificate for an API stage.

    Declaration

    Swift

    public let clientCertificateId: String?

  • The timestamp when the stage was created.

    Declaration

    Swift

    public let createdDate: TimeStamp?

  • The identifier of the Deployment that the stage points to.

    Declaration

    Swift

    public let deploymentId: String?

  • The stage’s description.

    Declaration

    Swift

    public let description: String?

  • The version of the associated API documentation.

    Declaration

    Swift

    public let documentationVersion: String?

  • The timestamp when the stage last updated.

    Declaration

    Swift

    public let lastUpdatedDate: TimeStamp?

  • A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /*/* for overriding all methods in the stage.

    Declaration

    Swift

    public let methodSettings: [String : MethodSetting]?

  • The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

    Declaration

    Swift

    public let stageName: String?

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

    Declaration

    Swift

    public let tags: [String : String]?

  • Specifies whether active tracing with X-ray is enabled for the Stage.

    Declaration

    Swift

    public let tracingEnabled: Bool?

  • 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 variables: [String : String]?

  • The ARN of the WebAcl associated with the Stage.

    Declaration

    Swift

    public let webAclArn: String?

  • Undocumented

    Declaration

    Swift

    public init(accessLogSettings: AccessLogSettings? = nil, cacheClusterEnabled: Bool? = nil, cacheClusterSize: CacheClusterSize? = nil, cacheClusterStatus: CacheClusterStatus? = nil, canarySettings: CanarySettings? = nil, clientCertificateId: String? = nil, createdDate: TimeStamp? = nil, deploymentId: String? = nil, description: String? = nil, documentationVersion: String? = nil, lastUpdatedDate: TimeStamp? = nil, methodSettings: [String : MethodSetting]? = nil, stageName: String? = nil, tags: [String : String]? = nil, tracingEnabled: Bool? = nil, variables: [String : String]? = nil, webAclArn: String? = nil)