Sharedflow class

You can combine policies and resources into a shared flow that you can consume from multiple API proxies, and even from other shared flows. Although it's like a proxy, a shared flow has no endpoint. It can be used only from an API proxy or shared flow that's in the same organization as the shared flow itself.

To get more information about SharedFlow, see:

• API documentation
• How-to Guides
• Sharedflows

Example Usage

Import

SharedFlow can be imported using any of these accepted formats:

• {{org_id}}/sharedflows/{{name}}
• {{org_id}}/{{name}}

When using the pulumi import command, SharedFlow can be imported using one of the formats above. For example:

$ pulumi import gcp:apigee/sharedflow:Sharedflow default {{org_id}}/sharedflows/{{name}}
$ pulumi import gcp:apigee/sharedflow:Sharedflow default {{org_id}}/{{name}}

Constructors

Sharedflow(String name, {SharedflowArgs? args, CustomResourceOptions? options})

Creates a new Sharedflow. name The Pulumi resource name. args Arguments used to configure this Sharedflow. The set of arguments for Sharedflow. options Resource options controlling this resource's behavior.

Sharedflow.reference(String urn)

Creates a typed reference to an existing Sharedflow resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configBundle ↔ Output<String>

Path to the config zip bundle.

late, final

deletionPolicy ↔ Output<String>

(Optional) Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

detectMd5hash ↔ Output<String?>

(Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

latestRevisionId ↔ Output<String>

The id of the most recently created revision for this shared flow.

late, final

md5hash ↔ Output<String>

(Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.

late, final

metaDatas ↔ Output<List<SharedflowMetaData>>

Metadata describing the shared flow. Structure is documented below.

late, final

name ↔ Output<String>

The ID of the shared flow.

late, final

orgId ↔ Output<String>

The Apigee Organization name associated with the Apigee instance.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

revisions ↔ Output<List<String>>

A list of revisions of this shared flow.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {SharedflowState? state, CustomResourceOptions? options}) → Sharedflow

Gets an existing Sharedflow resource's state with the given name and id.