1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. SharedflowDeployment
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.apigee.SharedflowDeployment

Explore with Pulumi AI

Deploys a revision of a sharedflow.

To get more information about SharedflowDeployment, see:

Create SharedflowDeployment Resource

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

Constructor syntax

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

@overload
def SharedflowDeployment(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         environment: Optional[str] = None,
                         org_id: Optional[str] = None,
                         revision: Optional[str] = None,
                         sharedflow_id: Optional[str] = None,
                         service_account: Optional[str] = None)
func NewSharedflowDeployment(ctx *Context, name string, args SharedflowDeploymentArgs, opts ...ResourceOption) (*SharedflowDeployment, error)
public SharedflowDeployment(string name, SharedflowDeploymentArgs args, CustomResourceOptions? opts = null)
public SharedflowDeployment(String name, SharedflowDeploymentArgs args)
public SharedflowDeployment(String name, SharedflowDeploymentArgs args, CustomResourceOptions options)
type: gcp:apigee:SharedflowDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SharedflowDeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SharedflowDeploymentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SharedflowDeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SharedflowDeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SharedflowDeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var sharedflowDeploymentResource = new Gcp.Apigee.SharedflowDeployment("sharedflowDeploymentResource", new()
{
    Environment = "string",
    OrgId = "string",
    Revision = "string",
    SharedflowId = "string",
    ServiceAccount = "string",
});
Copy
example, err := apigee.NewSharedflowDeployment(ctx, "sharedflowDeploymentResource", &apigee.SharedflowDeploymentArgs{
	Environment:    pulumi.String("string"),
	OrgId:          pulumi.String("string"),
	Revision:       pulumi.String("string"),
	SharedflowId:   pulumi.String("string"),
	ServiceAccount: pulumi.String("string"),
})
Copy
var sharedflowDeploymentResource = new SharedflowDeployment("sharedflowDeploymentResource", SharedflowDeploymentArgs.builder()
    .environment("string")
    .orgId("string")
    .revision("string")
    .sharedflowId("string")
    .serviceAccount("string")
    .build());
Copy
sharedflow_deployment_resource = gcp.apigee.SharedflowDeployment("sharedflowDeploymentResource",
    environment="string",
    org_id="string",
    revision="string",
    sharedflow_id="string",
    service_account="string")
Copy
const sharedflowDeploymentResource = new gcp.apigee.SharedflowDeployment("sharedflowDeploymentResource", {
    environment: "string",
    orgId: "string",
    revision: "string",
    sharedflowId: "string",
    serviceAccount: "string",
});
Copy
type: gcp:apigee:SharedflowDeployment
properties:
    environment: string
    orgId: string
    revision: string
    serviceAccount: string
    sharedflowId: string
Copy

SharedflowDeployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SharedflowDeployment resource accepts the following input properties:

Environment
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the environment.
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Sharedflow
Revision This property is required. string
Revision of the Sharedflow to be deployed.


SharedflowId
This property is required.
Changes to this property will trigger replacement.
string
Id of the Sharedflow to be deployed.
ServiceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
Environment
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the environment.
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Sharedflow
Revision This property is required. string
Revision of the Sharedflow to be deployed.


SharedflowId
This property is required.
Changes to this property will trigger replacement.
string
Id of the Sharedflow to be deployed.
ServiceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
environment
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the environment.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Sharedflow
revision This property is required. String
Revision of the Sharedflow to be deployed.


sharedflowId
This property is required.
Changes to this property will trigger replacement.
String
Id of the Sharedflow to be deployed.
serviceAccount Changes to this property will trigger replacement. String
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
environment
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the environment.
orgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Sharedflow
revision This property is required. string
Revision of the Sharedflow to be deployed.


sharedflowId
This property is required.
Changes to this property will trigger replacement.
string
Id of the Sharedflow to be deployed.
serviceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
environment
This property is required.
Changes to this property will trigger replacement.
str
The resource ID of the environment.
org_id
This property is required.
Changes to this property will trigger replacement.
str
The Apigee Organization associated with the Sharedflow
revision This property is required. str
Revision of the Sharedflow to be deployed.


sharedflow_id
This property is required.
Changes to this property will trigger replacement.
str
Id of the Sharedflow to be deployed.
service_account Changes to this property will trigger replacement. str
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
environment
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the environment.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Sharedflow
revision This property is required. String
Revision of the Sharedflow to be deployed.


sharedflowId
This property is required.
Changes to this property will trigger replacement.
String
Id of the Sharedflow to be deployed.
serviceAccount Changes to this property will trigger replacement. String
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.

Outputs

All input properties are implicitly available as output properties. Additionally, the SharedflowDeployment 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 SharedflowDeployment Resource

Get an existing SharedflowDeployment 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?: SharedflowDeploymentState, opts?: CustomResourceOptions): SharedflowDeployment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        environment: Optional[str] = None,
        org_id: Optional[str] = None,
        revision: Optional[str] = None,
        service_account: Optional[str] = None,
        sharedflow_id: Optional[str] = None) -> SharedflowDeployment
func GetSharedflowDeployment(ctx *Context, name string, id IDInput, state *SharedflowDeploymentState, opts ...ResourceOption) (*SharedflowDeployment, error)
public static SharedflowDeployment Get(string name, Input<string> id, SharedflowDeploymentState? state, CustomResourceOptions? opts = null)
public static SharedflowDeployment get(String name, Output<String> id, SharedflowDeploymentState state, CustomResourceOptions options)
resources:  _:    type: gcp:apigee:SharedflowDeployment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Environment Changes to this property will trigger replacement. string
The resource ID of the environment.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Sharedflow
Revision string
Revision of the Sharedflow to be deployed.


ServiceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
SharedflowId Changes to this property will trigger replacement. string
Id of the Sharedflow to be deployed.
Environment Changes to this property will trigger replacement. string
The resource ID of the environment.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Sharedflow
Revision string
Revision of the Sharedflow to be deployed.


ServiceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
SharedflowId Changes to this property will trigger replacement. string
Id of the Sharedflow to be deployed.
environment Changes to this property will trigger replacement. String
The resource ID of the environment.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Sharedflow
revision String
Revision of the Sharedflow to be deployed.


serviceAccount Changes to this property will trigger replacement. String
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
sharedflowId Changes to this property will trigger replacement. String
Id of the Sharedflow to be deployed.
environment Changes to this property will trigger replacement. string
The resource ID of the environment.
orgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Sharedflow
revision string
Revision of the Sharedflow to be deployed.


serviceAccount Changes to this property will trigger replacement. string
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
sharedflowId Changes to this property will trigger replacement. string
Id of the Sharedflow to be deployed.
environment Changes to this property will trigger replacement. str
The resource ID of the environment.
org_id Changes to this property will trigger replacement. str
The Apigee Organization associated with the Sharedflow
revision str
Revision of the Sharedflow to be deployed.


service_account Changes to this property will trigger replacement. str
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
sharedflow_id Changes to this property will trigger replacement. str
Id of the Sharedflow to be deployed.
environment Changes to this property will trigger replacement. String
The resource ID of the environment.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Sharedflow
revision String
Revision of the Sharedflow to be deployed.


serviceAccount Changes to this property will trigger replacement. String
The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.
sharedflowId Changes to this property will trigger replacement. String
Id of the Sharedflow to be deployed.

Import

SharedflowDeployment can be imported using any of these accepted formats:

  • organizations/{{org_id}}/environments/{{environment}}/sharedflows/{{sharedflow_id}}/revisions/{{revision}}/deployments/{{name}}

  • {{org_id}}/{{environment}}/{{sharedflow_id}}/{{revision}}/{{name}}

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

$ pulumi import gcp:apigee/sharedflowDeployment:SharedflowDeployment default organizations/{{org_id}}/environments/{{environment}}/sharedflows/{{sharedflow_id}}/revisions/{{revision}}/deployments/{{name}}
Copy
$ pulumi import gcp:apigee/sharedflowDeployment:SharedflowDeployment default {{org_id}}/{{environment}}/{{sharedflow_id}}/{{revision}}/{{name}}
Copy

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.