Package com.pulumi.aws.apigatewayv2.inputs

Class StageState

  • public final class StageState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StageState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static StageState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<StageAccessLogSettingsArgs>> accessLogSettings()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoDeploy()  
      static StageState.Builder builder()  
      static StageState.Builder builder​(StageState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> clientCertificateId()  
      java.util.Optional<com.pulumi.core.Output<StageDefaultRouteSettingsArgs>> defaultRouteSettings()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> deploymentId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> invokeUrl()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<StageRouteSettingArgs>>> routeSettings()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> stageVariables()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • accessLogSettings

        public java.util.Optional<com.pulumi.core.Output<StageAccessLogSettingsArgs>> 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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiId()
        Returns:
        API identifier.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the stage.

      • autoDeploy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoDeploy()
        Returns:
        Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs.

      • clientCertificateId

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<StageDefaultRouteSettingsArgs>> defaultRouteSettings()
        Returns:
        Default route settings for the stage.

      • deploymentId

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description for the stage. Must be less than or equal to 1024 characters in length.

      • executionArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionArn()
        Returns:
        ARN prefix to be used in an `aws.lambda.Permission`'s `sourceArn` 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 java.util.Optional<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 java.util.Optional<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:

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • routeSettings

        public java.util.Optional<com.pulumi.core.Output<java.util.List<StageRouteSettingArgs>>> routeSettings()
        Returns:
        Route settings for the stage.

      • stageVariables

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> stageVariables()
        Returns:
        Map that defines the stage variables for the stage.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the stage. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<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 `defaultTags` configuration block.