Package com.pulumi.aws.apigatewayv2
Class Stage
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.apigatewayv2.Stage
-
public class Stage extends com.pulumi.resources.CustomResource
Manages an Amazon API Gateway Version 2 stage. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html). ## Example Usage ### Basic <!--Start PulumiCodeChooser -->package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.apigatewayv2.Stage; import com.pulumi.aws.apigatewayv2.StageArgs; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Stage("example", StageArgs.builder() .apiId(exampleAwsApigatewayv2Api.id()) .name("example-stage") .build()); } }
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.util.Optional<StageAccessLogSettings>>
accessLogSettings()
com.pulumi.core.Output<java.lang.String>
apiId()
com.pulumi.core.Output<java.lang.String>
arn()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>
autoDeploy()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>
clientCertificateId()
com.pulumi.core.Output<java.util.Optional<StageDefaultRouteSettings>>
defaultRouteSettings()
com.pulumi.core.Output<java.lang.String>
deploymentId()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>
description()
com.pulumi.core.Output<java.lang.String>
executionArn()
static Stage
get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, StageState state, com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>
invokeUrl()
com.pulumi.core.Output<java.lang.String>
name()
com.pulumi.core.Output<java.util.Optional<java.util.List<StageRouteSetting>>>
routeSettings()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>
stageVariables()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>
tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>
tagsAll()
-
-
-
Constructor Detail
-
Stage
public Stage(java.lang.String name)
- Parameters:
name
- The _unique_ name of the resulting resource.
-
Stage
public Stage(java.lang.String name, StageArgs args)
- Parameters:
name
- The _unique_ name of the resulting resource.args
- The arguments to use to populate this resource's properties.
-
Stage
public Stage(java.lang.String name, StageArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)
- Parameters:
name
- The _unique_ name of the resulting resource.args
- The arguments to use to populate this resource's properties.options
- A bag of options that control this resource's behavior.
-
-
Method Detail
-
accessLogSettings
public com.pulumi.core.Output<java.util.Optional<StageAccessLogSettings>> accessLogSettings()
- Returns:
- Settings for logging access in this stage. Use the `aws.apigateway.Account` resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions).
-
apiId
public com.pulumi.core.Output<java.lang.String> apiId()
- Returns:
- API identifier.
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the stage.
-
autoDeploy
public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> autoDeploy()
- Returns:
- Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs.
-
clientCertificateId
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientCertificateId()
- Returns:
- Identifier of a client certificate for the stage. Use the `aws.apigateway.ClientCertificate` resource to configure a client certificate. Supported only for WebSocket APIs.
-
defaultRouteSettings
public com.pulumi.core.Output<java.util.Optional<StageDefaultRouteSettings>> defaultRouteSettings()
- Returns:
- Default route settings for the stage.
-
deploymentId
public com.pulumi.core.Output<java.lang.String> deploymentId()
- Returns:
- Deployment identifier of the stage. Use the `aws.apigatewayv2.Deployment` resource to configure a deployment.
-
description
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
- Returns:
- Description for the stage. Must be less than or equal to 1024 characters in length.
-
executionArn
public com.pulumi.core.Output<java.lang.String> executionArn()
- Returns:
- ARN prefix to be used in an `aws.lambda.Permission`'s `source_arn` attribute. For WebSocket APIs this attribute can additionally be used in an `aws.iam.Policy` to authorize access to the [`@connections` API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html). See the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html) for details.
-
invokeUrl
public com.pulumi.core.Output<java.lang.String> invokeUrl()
- Returns:
- URL to invoke the API pointing to the stage, e.g., `wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage`, or `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/`
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Name of the stage. Must be between 1 and 128 characters in length. The following arguments are optional:
-
routeSettings
public com.pulumi.core.Output<java.util.Optional<java.util.List<StageRouteSetting>>> routeSettings()
- Returns:
- Route settings for the stage.
-
stageVariables
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> stageVariables()
- Returns:
- Map that defines the stage variables for the stage.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Map of tags to assign to the stage. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
-
get
public static Stage get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable StageState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name
- The _unique_ name of the resulting resource.id
- The _unique_ provider ID of the resource to lookup.state
-options
- Optional settings to control the behavior of the CustomResource.
-
-