Package com.pulumi.aws.apigatewayv2.inputs

Class StageState.Builder

  • Enclosing class:
    StageState
    public static final class StageState.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(StageState defaults)

    • Method Detail

      • accessLogSettings

        public StageState.Builder accessLogSettings​(@Nullable
                                            com.pulumi.core.Output<StageAccessLogSettingsArgs> accessLogSettings)
        Parameters:
        accessLogSettings - 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).
        Returns:
        builder

      • accessLogSettings

        public StageState.Builder accessLogSettings​(StageAccessLogSettingsArgs accessLogSettings)
        Parameters:
        accessLogSettings - 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).
        Returns:
        builder

      • apiId

        public StageState.Builder apiId​(@Nullable
                                com.pulumi.core.Output<java.lang.String> apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder

      • apiId

        public StageState.Builder apiId​(java.lang.String apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder

      • arn

        public StageState.Builder arn​(@Nullable
                              com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - ARN of the stage.
        Returns:
        builder

      • arn

        public StageState.Builder arn​(java.lang.String arn)
        Parameters:
        arn - ARN of the stage.
        Returns:
        builder

      • autoDeploy

        public StageState.Builder autoDeploy​(@Nullable
                                     com.pulumi.core.Output<java.lang.Boolean> autoDeploy)
        Parameters:
        autoDeploy - Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs.
        Returns:
        builder

      • autoDeploy

        public StageState.Builder autoDeploy​(java.lang.Boolean autoDeploy)
        Parameters:
        autoDeploy - Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs.
        Returns:
        builder

      • clientCertificateId

        public StageState.Builder clientCertificateId​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> clientCertificateId)
        Parameters:
        clientCertificateId - Identifier of a client certificate for the stage. Use the `aws.apigateway.ClientCertificate` resource to configure a client certificate. Supported only for WebSocket APIs.
        Returns:
        builder

      • clientCertificateId

        public StageState.Builder clientCertificateId​(java.lang.String clientCertificateId)
        Parameters:
        clientCertificateId - Identifier of a client certificate for the stage. Use the `aws.apigateway.ClientCertificate` resource to configure a client certificate. Supported only for WebSocket APIs.
        Returns:
        builder

      • defaultRouteSettings

        public StageState.Builder defaultRouteSettings​(@Nullable
                                               com.pulumi.core.Output<StageDefaultRouteSettingsArgs> defaultRouteSettings)
        Parameters:
        defaultRouteSettings - Default route settings for the stage.
        Returns:
        builder

      • deploymentId

        public StageState.Builder deploymentId​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> deploymentId)
        Parameters:
        deploymentId - Deployment identifier of the stage. Use the `aws.apigatewayv2.Deployment` resource to configure a deployment.
        Returns:
        builder

      • deploymentId

        public StageState.Builder deploymentId​(java.lang.String deploymentId)
        Parameters:
        deploymentId - Deployment identifier of the stage. Use the `aws.apigatewayv2.Deployment` resource to configure a deployment.
        Returns:
        builder

      • description

        public StageState.Builder description​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> description)
        Parameters:
        description - Description for the stage. Must be less than or equal to 1024 characters in length.
        Returns:
        builder

      • description

        public StageState.Builder description​(java.lang.String description)
        Parameters:
        description - Description for the stage. Must be less than or equal to 1024 characters in length.
        Returns:
        builder

      • executionArn

        public StageState.Builder executionArn​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> executionArn)
        Parameters:
        executionArn - 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.
        Returns:
        builder

      • executionArn

        public StageState.Builder executionArn​(java.lang.String executionArn)
        Parameters:
        executionArn - 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.
        Returns:
        builder

      • invokeUrl

        public StageState.Builder invokeUrl​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> invokeUrl)
        Parameters:
        invokeUrl - 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/`
        Returns:
        builder

      • invokeUrl

        public StageState.Builder invokeUrl​(java.lang.String invokeUrl)
        Parameters:
        invokeUrl - 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/`
        Returns:
        builder

      • name

        public StageState.Builder name​(@Nullable
                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the stage. Must be between 1 and 128 characters in length. The following arguments are optional:
        Returns:
        builder

      • name

        public StageState.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the stage. Must be between 1 and 128 characters in length. The following arguments are optional:
        Returns:
        builder

      • region

        public StageState.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public StageState.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • routeSettings

        public StageState.Builder routeSettings​(@Nullable
                                        com.pulumi.core.Output<java.util.List<StageRouteSettingArgs>> routeSettings)
        Parameters:
        routeSettings - Route settings for the stage.
        Returns:
        builder

      • stageVariables

        public StageState.Builder stageVariables​(@Nullable
                                         com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> stageVariables)
        Parameters:
        stageVariables - Map that defines the stage variables for the stage.
        Returns:
        builder

      • stageVariables

        public StageState.Builder stageVariables​(java.util.Map<java.lang.String,​java.lang.String> stageVariables)
        Parameters:
        stageVariables - Map that defines the stage variables for the stage.
        Returns:
        builder

      • tags

        public StageState.Builder tags​(@Nullable
                               com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public StageState.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tagsAll

        public StageState.Builder tagsAll​(@Nullable
                                  com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll)
        Parameters:
        tagsAll - Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder

      • tagsAll

        public StageState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Parameters:
        tagsAll - Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder