Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. Sharedflow
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.apigee.Sharedflow

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

    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:

    Create Sharedflow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Sharedflow(name: string, args: SharedflowArgs, opts?: CustomResourceOptions);
    @overload
def Sharedflow(resource_name: str,
               args: SharedflowArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Sharedflow(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               config_bundle: Optional[str] = None,
               org_id: Optional[str] = None,
               detect_md5hash: Optional[str] = None,
               name: Optional[str] = None)
    func NewSharedflow(ctx *Context, name string, args SharedflowArgs, opts ...ResourceOption) (*Sharedflow, error)
    public Sharedflow(string name, SharedflowArgs args, CustomResourceOptions? opts = null)
    public Sharedflow(String name, SharedflowArgs args)
public Sharedflow(String name, SharedflowArgs args, CustomResourceOptions options)

    type: gcp:apigee:Sharedflow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SharedflowArgs
    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 SharedflowArgs
    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 SharedflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharedflowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var sharedflowResource = new Gcp.Apigee.Sharedflow("sharedflowResource", new()
{
    ConfigBundle = "string",
    OrgId = "string",
    DetectMd5hash = "string",
    Name = "string",
});

    example, err := apigee.NewSharedflow(ctx, "sharedflowResource", &apigee.SharedflowArgs{
	ConfigBundle:  pulumi.String("string"),
	OrgId:         pulumi.String("string"),
	DetectMd5hash: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

    var sharedflowResource = new Sharedflow("sharedflowResource", SharedflowArgs.builder()        
    .configBundle("string")
    .orgId("string")
    .detectMd5hash("string")
    .name("string")
    .build());

    sharedflow_resource = gcp.apigee.Sharedflow("sharedflowResource",
    config_bundle="string",
    org_id="string",
    detect_md5hash="string",
    name="string")

    const sharedflowResource = new gcp.apigee.Sharedflow("sharedflowResource", {
    configBundle: "string",
    orgId: "string",
    detectMd5hash: "string",
    name: "string",
});

    type: gcp:apigee:Sharedflow
properties:
    configBundle: string
    detectMd5hash: string
    name: string
    orgId: string

    Sharedflow 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 Sharedflow resource accepts the following input properties:

    ConfigBundle string
    Path to the config zip bundle.

    OrgId string
    The Apigee Organization name associated with the Apigee instance.
    DetectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    Name string
    The ID of the shared flow.
    ConfigBundle string
    Path to the config zip bundle.

    OrgId string
    The Apigee Organization name associated with the Apigee instance.
    DetectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    Name string
    The ID of the shared flow.
    configBundle String
    Path to the config zip bundle.

    orgId String
    The Apigee Organization name associated with the Apigee instance.
    detectMd5hash String
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    name String
    The ID of the shared flow.
    configBundle string
    Path to the config zip bundle.

    orgId string
    The Apigee Organization name associated with the Apigee instance.
    detectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    name string
    The ID of the shared flow.
    config_bundle str
    Path to the config zip bundle.

    org_id str
    The Apigee Organization name associated with the Apigee instance.
    detect_md5hash str
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    name str
    The ID of the shared flow.
    configBundle String
    Path to the config zip bundle.

    orgId String
    The Apigee Organization name associated with the Apigee instance.
    detectMd5hash String
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    name String
    The ID of the shared flow.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Sharedflow resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevisionId string
    The id of the most recently created revision for this shared flow.
    Md5hash 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 last_modified timestamp.
    MetaDatas List<SharedflowMetaData>
    Metadata describing the shared flow. Structure is documented below.
    Revisions List<string>
    A list of revisions of this shared flow.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestRevisionId string
    The id of the most recently created revision for this shared flow.
    Md5hash 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 last_modified timestamp.
    MetaDatas []SharedflowMetaData
    Metadata describing the shared flow. Structure is documented below.
    Revisions []string
    A list of revisions of this shared flow.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevisionId String
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas List<SharedflowMetaData>
    Metadata describing the shared flow. Structure is documented below.
    revisions List<String>
    A list of revisions of this shared flow.
    id string
    The provider-assigned unique ID for this managed resource.
    latestRevisionId string
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas SharedflowMetaData[]
    Metadata describing the shared flow. Structure is documented below.
    revisions string[]
    A list of revisions of this shared flow.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_revision_id str
    The id of the most recently created revision for this shared flow.
    md5hash str
    (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 last_modified timestamp.
    meta_datas Sequence[SharedflowMetaData]
    Metadata describing the shared flow. Structure is documented below.
    revisions Sequence[str]
    A list of revisions of this shared flow.
    id String
    The provider-assigned unique ID for this managed resource.
    latestRevisionId String
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas List<Property Map>
    Metadata describing the shared flow. Structure is documented below.
    revisions List<String>
    A list of revisions of this shared flow.

    Look up Existing Sharedflow Resource

    Get an existing Sharedflow 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?: SharedflowState, opts?: CustomResourceOptions): Sharedflow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_bundle: Optional[str] = None,
        detect_md5hash: Optional[str] = None,
        latest_revision_id: Optional[str] = None,
        md5hash: Optional[str] = None,
        meta_datas: Optional[Sequence[SharedflowMetaDataArgs]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        revisions: Optional[Sequence[str]] = None) -> Sharedflow
    func GetSharedflow(ctx *Context, name string, id IDInput, state *SharedflowState, opts ...ResourceOption) (*Sharedflow, error)
    public static Sharedflow Get(string name, Input<string> id, SharedflowState? state, CustomResourceOptions? opts = null)
    public static Sharedflow get(String name, Output<String> id, SharedflowState 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.
    The following state arguments are supported:
    ConfigBundle string
    Path to the config zip bundle.

    DetectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    LatestRevisionId string
    The id of the most recently created revision for this shared flow.
    Md5hash 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 last_modified timestamp.
    MetaDatas List<SharedflowMetaData>
    Metadata describing the shared flow. Structure is documented below.
    Name string
    The ID of the shared flow.
    OrgId string
    The Apigee Organization name associated with the Apigee instance.
    Revisions List<string>
    A list of revisions of this shared flow.
    ConfigBundle string
    Path to the config zip bundle.

    DetectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    LatestRevisionId string
    The id of the most recently created revision for this shared flow.
    Md5hash 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 last_modified timestamp.
    MetaDatas []SharedflowMetaDataArgs
    Metadata describing the shared flow. Structure is documented below.
    Name string
    The ID of the shared flow.
    OrgId string
    The Apigee Organization name associated with the Apigee instance.
    Revisions []string
    A list of revisions of this shared flow.
    configBundle String
    Path to the config zip bundle.

    detectMd5hash String
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    latestRevisionId String
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas List<SharedflowMetaData>
    Metadata describing the shared flow. Structure is documented below.
    name String
    The ID of the shared flow.
    orgId String
    The Apigee Organization name associated with the Apigee instance.
    revisions List<String>
    A list of revisions of this shared flow.
    configBundle string
    Path to the config zip bundle.

    detectMd5hash string
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    latestRevisionId string
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas SharedflowMetaData[]
    Metadata describing the shared flow. Structure is documented below.
    name string
    The ID of the shared flow.
    orgId string
    The Apigee Organization name associated with the Apigee instance.
    revisions string[]
    A list of revisions of this shared flow.
    config_bundle str
    Path to the config zip bundle.

    detect_md5hash str
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    latest_revision_id str
    The id of the most recently created revision for this shared flow.
    md5hash str
    (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 last_modified timestamp.
    meta_datas Sequence[SharedflowMetaDataArgs]
    Metadata describing the shared flow. Structure is documented below.
    name str
    The ID of the shared flow.
    org_id str
    The Apigee Organization name associated with the Apigee instance.
    revisions Sequence[str]
    A list of revisions of this shared flow.
    configBundle String
    Path to the config zip bundle.

    detectMd5hash String
    A hash of local config bundle in string, user needs to use a Terraform Hash function of their choice. A change in hash will trigger an update.
    latestRevisionId String
    The id of the most recently created revision for this shared flow.
    md5hash 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 last_modified timestamp.
    metaDatas List<Property Map>
    Metadata describing the shared flow. Structure is documented below.
    name String
    The ID of the shared flow.
    orgId String
    The Apigee Organization name associated with the Apigee instance.
    revisions List<String>
    A list of revisions of this shared flow.

    Supporting Types

    SharedflowMetaData, SharedflowMetaDataArgs

    CreatedAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    LastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    SubType string
    The type of entity described
    CreatedAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    LastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    SubType string
    The type of entity described
    createdAt String
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt String
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType String
    The type of entity described
    createdAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType string
    The type of entity described
    created_at str
    Time at which the API proxy was created, in milliseconds since epoch.
    last_modified_at str
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    sub_type str
    The type of entity described
    createdAt String
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt String
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType String
    The type of entity described

    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}}

    To learn more about importing existing cloud resources, see Importing resources.

    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.
    gcp logo
    Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-gcp