Interface CreateWebFunctionEndpointRequest.Builder

  • Method Details

    • functionName

      The name of the web function to create the endpoint for. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

      Parameters:
      functionName - The name of the web function to create the endpoint for. You can specify the function name or the function ARN. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpointName

      The name of the endpoint to create. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

      Parameters:
      endpointName - The name of the endpoint to create. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      A description of the endpoint.

      Parameters:
      description - A description of the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpointType

      The type of endpoint to create. Determines how traffic is served and routed across Regions.

      Parameters:
      endpointType - The type of endpoint to create. Determines how traffic is served and routed across Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • endpointType

      The type of endpoint to create. Determines how traffic is served and routed across Regions.

      Parameters:
      endpointType - The type of endpoint to create. Determines how traffic is served and routed across Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • authType

      The authorization type for the endpoint.

      Parameters:
      authType - The authorization type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • authType

      The authorization type for the endpoint.

      Parameters:
      authType - The authorization type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • autoDeploymentMode

      CreateWebFunctionEndpointRequest.Builder autoDeploymentMode(String autoDeploymentMode)

      The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.

      Parameters:
      autoDeploymentMode - The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • autoDeploymentMode

      CreateWebFunctionEndpointRequest.Builder autoDeploymentMode(AutoDeploymentMode autoDeploymentMode)

      The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.

      Parameters:
      autoDeploymentMode - The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • revisionWeights

      A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.

      Parameters:
      revisionWeights - A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • revisionWeights

      CreateWebFunctionEndpointRequest.Builder revisionWeights(RevisionWeight... revisionWeights)

      A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.

      Parameters:
      revisionWeights - A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • revisionWeights

      A list of revision weights that determine how traffic is distributed across revisions. Up to two revisions can be specified for canary or blue-green deployments.

      This is a convenience method that creates an instance of the RevisionWeight.Builder avoiding the need to create one manually via RevisionWeight.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to revisionWeights(List<RevisionWeight>).

      Parameters:
      revisionWeights - a consumer that will call methods on RevisionWeight.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • regions

      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

      Parameters:
      regions - The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • regions

      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

      Parameters:
      regions - The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scalingConfig

      The scaling configuration for the endpoint. There is no default value. If you don't specify a scaling configuration, it is absent from the response.

      Parameters:
      scalingConfig - The scaling configuration for the endpoint. There is no default value. If you don't specify a scaling configuration, it is absent from the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scalingConfig

      The scaling configuration for the endpoint. There is no default value. If you don't specify a scaling configuration, it is absent from the response.

      This is a convenience method that creates an instance of the ScalingConfig.Builder avoiding the need to create one manually via ScalingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfig(ScalingConfig).

      Parameters:
      scalingConfig - a consumer that will call methods on ScalingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • throttleConfig

      The throttling configuration for the endpoint. There is no default value. If you don't specify a throttling configuration, it is absent from the response.

      Parameters:
      throttleConfig - The throttling configuration for the endpoint. There is no default value. If you don't specify a throttling configuration, it is absent from the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • throttleConfig

      The throttling configuration for the endpoint. There is no default value. If you don't specify a throttling configuration, it is absent from the response.

      This is a convenience method that creates an instance of the ThrottleConfig.Builder avoiding the need to create one manually via ThrottleConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to throttleConfig(ThrottleConfig).

      Parameters:
      throttleConfig - a consumer that will call methods on ThrottleConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateWebFunctionEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.