1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. SharedflowDeployment
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.apigee.SharedflowDeployment

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

    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 string
    The unique name of the resource.
    args SharedflowDeploymentArgs
    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 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 string
    The unique name of the resource.
    args SharedflowDeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharedflowDeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    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"),
    })
    
    var sharedflowDeploymentResource = new SharedflowDeployment("sharedflowDeploymentResource", SharedflowDeploymentArgs.builder()
        .environment("string")
        .orgId("string")
        .revision("string")
        .sharedflowId("string")
        .serviceAccount("string")
        .build());
    
    sharedflow_deployment_resource = gcp.apigee.SharedflowDeployment("sharedflowDeploymentResource",
        environment="string",
        org_id="string",
        revision="string",
        sharedflow_id="string",
        service_account="string")
    
    const sharedflowDeploymentResource = new gcp.apigee.SharedflowDeployment("sharedflowDeploymentResource", {
        environment: "string",
        orgId: "string",
        revision: "string",
        sharedflowId: "string",
        serviceAccount: "string",
    });
    
    type: gcp:apigee:SharedflowDeployment
    properties:
        environment: string
        orgId: string
        revision: string
        serviceAccount: string
        sharedflowId: string
    

    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 string
    The resource ID of the environment.
    OrgId string
    The Apigee Organization associated with the Sharedflow
    Revision string
    Revision of the Sharedflow to be deployed.


    SharedflowId string
    Id of the Sharedflow to be deployed.
    ServiceAccount 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 string
    The resource ID of the environment.
    OrgId string
    The Apigee Organization associated with the Sharedflow
    Revision string
    Revision of the Sharedflow to be deployed.


    SharedflowId string
    Id of the Sharedflow to be deployed.
    ServiceAccount 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 String
    The resource ID of the environment.
    orgId String
    The Apigee Organization associated with the Sharedflow
    revision String
    Revision of the Sharedflow to be deployed.


    sharedflowId String
    Id of the Sharedflow to be deployed.
    serviceAccount 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 string
    The resource ID of the environment.
    orgId string
    The Apigee Organization associated with the Sharedflow
    revision string
    Revision of the Sharedflow to be deployed.


    sharedflowId string
    Id of the Sharedflow to be deployed.
    serviceAccount 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 str
    The resource ID of the environment.
    org_id str
    The Apigee Organization associated with the Sharedflow
    revision str
    Revision of the Sharedflow to be deployed.


    sharedflow_id str
    Id of the Sharedflow to be deployed.
    service_account 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 String
    The resource ID of the environment.
    orgId String
    The Apigee Organization associated with the Sharedflow
    revision String
    Revision of the Sharedflow to be deployed.


    sharedflowId String
    Id of the Sharedflow to be deployed.
    serviceAccount 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)
    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:
    Environment string
    The resource ID of the environment.
    OrgId string
    The Apigee Organization associated with the Sharedflow
    Revision string
    Revision of the Sharedflow to be deployed.


    ServiceAccount 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 string
    Id of the Sharedflow to be deployed.
    Environment string
    The resource ID of the environment.
    OrgId string
    The Apigee Organization associated with the Sharedflow
    Revision string
    Revision of the Sharedflow to be deployed.


    ServiceAccount 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 string
    Id of the Sharedflow to be deployed.
    environment String
    The resource ID of the environment.
    orgId String
    The Apigee Organization associated with the Sharedflow
    revision String
    Revision of the Sharedflow to be deployed.


    serviceAccount 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 String
    Id of the Sharedflow to be deployed.
    environment string
    The resource ID of the environment.
    orgId string
    The Apigee Organization associated with the Sharedflow
    revision string
    Revision of the Sharedflow to be deployed.


    serviceAccount 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 string
    Id of the Sharedflow to be deployed.
    environment str
    The resource ID of the environment.
    org_id str
    The Apigee Organization associated with the Sharedflow
    revision str
    Revision of the Sharedflow to be deployed.


    service_account 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 str
    Id of the Sharedflow to be deployed.
    environment String
    The resource ID of the environment.
    orgId String
    The Apigee Organization associated with the Sharedflow
    revision String
    Revision of the Sharedflow to be deployed.


    serviceAccount 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 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}}
    
    $ pulumi import gcp:apigee/sharedflowDeployment:SharedflowDeployment default {{org_id}}/{{environment}}/{{sharedflow_id}}/{{revision}}/{{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 v8.9.3 published on Monday, Nov 18, 2024 by Pulumi