Package com.pulumi.aws.apigateway.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>> arn()  
      static StageState.Builder builder()  
      static StageState.Builder builder​(StageState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> cacheClusterEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheClusterSize()  
      java.util.Optional<com.pulumi.core.Output<StageCanarySettingsArgs>> canarySettings()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> clientCertificateId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> deployment()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentationVersion()  
      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>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> restApi()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> stageName()  
      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()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> variables()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> webAclArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> xrayTracingEnabled()  

      • 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:
        Enables access logs for the API stage. See `accessLogSettings` Block below.

      • arn

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

      • cacheClusterEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> cacheClusterEnabled()
        Returns:
        Whether a cache cluster is enabled for the stage

      • cacheClusterSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheClusterSize()
        Returns:
        Size of the cache cluster for the stage, if enabled. Allowed values include `0.5`, `1.6`, `6.1`, `13.5`, `28.4`, `58.2`, `118` and `237`.

      • canarySettings

        public java.util.Optional<com.pulumi.core.Output<StageCanarySettingsArgs>> canarySettings()
        Returns:
        Configuration settings of a canary deployment. See `canarySettings` Block below.

      • clientCertificateId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clientCertificateId()
        Returns:
        Identifier of a client certificate for the stage.

      • deployment

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> deployment()
        Returns:
        ID of the deployment that the stage points to

      • description

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

      • documentationVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentationVersion()
        Returns:
        Version of the associated API documentation.

      • executionArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionArn()
        Returns:
        Execution ARN to be used in `lambdaPermission`'s `sourceArn` when allowing API Gateway to invoke a Lambda function, e.g., `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod`

      • 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., `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod`

      • 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.

      • restApi

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restApi()
        Returns:
        ID of the associated REST API

      • stageName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> stageName()
        Returns:
        Name of 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 resource. 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.

      • variables

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

      • webAclArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> webAclArn()
        Returns:
        ARN of the WebAcl associated with the Stage.

      • xrayTracingEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> xrayTracingEnabled()
        Returns:
        Whether active tracing with X-ray is enabled. Defaults to `false`.