Google Cloud Classic v6.57.0, May 30 23
Google Cloud Classic v6.57.0, May 30 23
gcp.apigee.Flowhook
Explore with Pulumi AI
Represents a sharedflow attachment to a flowhook point.
To get more information about Flowhook, see:
Create Flowhook Resource
new Flowhook(name: string, args: FlowhookArgs, opts?: CustomResourceOptions);
@overload
def Flowhook(resource_name: str,
opts: Optional[ResourceOptions] = None,
continue_on_error: Optional[bool] = None,
description: Optional[str] = None,
environment: Optional[str] = None,
flow_hook_point: Optional[str] = None,
org_id: Optional[str] = None,
sharedflow: Optional[str] = None)
@overload
def Flowhook(resource_name: str,
args: FlowhookArgs,
opts: Optional[ResourceOptions] = None)
func NewFlowhook(ctx *Context, name string, args FlowhookArgs, opts ...ResourceOption) (*Flowhook, error)
public Flowhook(string name, FlowhookArgs args, CustomResourceOptions? opts = null)
public Flowhook(String name, FlowhookArgs args)
public Flowhook(String name, FlowhookArgs args, CustomResourceOptions options)
type: gcp:apigee:Flowhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlowhookArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FlowhookArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlowhookArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlowhookArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlowhookArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Flowhook Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Flowhook resource accepts the following input properties:
- Environment string
The resource ID of the environment.
- Flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- Org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- Continue
On boolError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- Description string
Description of the flow hook.
- Environment string
The resource ID of the environment.
- Flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- Org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- Continue
On boolError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- Description string
Description of the flow hook.
- environment String
The resource ID of the environment.
- flow
Hook StringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id String The Apigee Organization associated with the environment
- String
Id of the Sharedflow attaching to a flowhook point.
- continue
On BooleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description String
Description of the flow hook.
- environment string
The resource ID of the environment.
- flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- continue
On booleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description string
Description of the flow hook.
- environment str
The resource ID of the environment.
- flow_
hook_ strpoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org_
id str The Apigee Organization associated with the environment
- str
Id of the Sharedflow attaching to a flowhook point.
- continue_
on_ boolerror Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description str
Description of the flow hook.
- environment String
The resource ID of the environment.
- flow
Hook StringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id String The Apigee Organization associated with the environment
- String
Id of the Sharedflow attaching to a flowhook point.
- continue
On BooleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description String
Description of the flow hook.
Outputs
All input properties are implicitly available as output properties. Additionally, the Flowhook resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Flowhook Resource
Get an existing Flowhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FlowhookState, opts?: CustomResourceOptions): Flowhook
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
continue_on_error: Optional[bool] = None,
description: Optional[str] = None,
environment: Optional[str] = None,
flow_hook_point: Optional[str] = None,
org_id: Optional[str] = None,
sharedflow: Optional[str] = None) -> Flowhook
func GetFlowhook(ctx *Context, name string, id IDInput, state *FlowhookState, opts ...ResourceOption) (*Flowhook, error)
public static Flowhook Get(string name, Input<string> id, FlowhookState? state, CustomResourceOptions? opts = null)
public static Flowhook get(String name, Output<String> id, FlowhookState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Continue
On boolError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- Description string
Description of the flow hook.
- Environment string
The resource ID of the environment.
- Flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- Org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- Continue
On boolError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- Description string
Description of the flow hook.
- Environment string
The resource ID of the environment.
- Flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- Org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- continue
On BooleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description String
Description of the flow hook.
- environment String
The resource ID of the environment.
- flow
Hook StringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id String The Apigee Organization associated with the environment
- String
Id of the Sharedflow attaching to a flowhook point.
- continue
On booleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description string
Description of the flow hook.
- environment string
The resource ID of the environment.
- flow
Hook stringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id string The Apigee Organization associated with the environment
- string
Id of the Sharedflow attaching to a flowhook point.
- continue_
on_ boolerror Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description str
Description of the flow hook.
- environment str
The resource ID of the environment.
- flow_
hook_ strpoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org_
id str The Apigee Organization associated with the environment
- str
Id of the Sharedflow attaching to a flowhook point.
- continue
On BooleanError Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception. Defaults to true.
- description String
Description of the flow hook.
- environment String
The resource ID of the environment.
- flow
Hook StringPoint Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
- org
Id String The Apigee Organization associated with the environment
- String
Id of the Sharedflow attaching to a flowhook point.
Import
Flowhook can be imported using any of these accepted formats
$ pulumi import gcp:apigee/flowhook:Flowhook default organizations/{{org_id}}/environments/{{environment}}/flowhooks/{{flow_hook_point}}
$ pulumi import gcp:apigee/flowhook:Flowhook default {{org_id}}/{{environment}}/{{flow_hook_point}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.