Class: Aws::APIGateway::Types::CreateStageRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Requests API Gateway to create a Stage resource.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_enabledBoolean

Whether cache clustering is enabled for the stage.

Returns:

  • (Boolean)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_sizeString

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#canary_settingsTypes::CanarySettings

The canary deployment settings of this stage.



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_idString

The identifier of the Deployment resource for the Stage resource.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the Stage resource.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_versionString

The version of the associated API documentation.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_nameString

The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns:

  • (String)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

  • (Hash<String,String>)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tracing_enabledBoolean

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

Returns:

  • (Boolean)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#variablesHash<String,String>

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

Returns:

  • (Hash<String,String>)


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1102

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version,
  :canary_settings,
  :tracing_enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end