1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. EnvironmentAddonsConfig
Google Cloud v8.18.0 published on Tuesday, Feb 4, 2025 by Pulumi

gcp.apigee.EnvironmentAddonsConfig

Explore with Pulumi AI

gcp logo
Google Cloud v8.18.0 published on Tuesday, Feb 4, 2025 by Pulumi

    Enable/Disable add-ons for an Apigee environment.

    To get more information about EnvironmentAddonsConfig, see:

    Example Usage

    Create EnvironmentAddonsConfig Resource

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

    Constructor syntax

    new EnvironmentAddonsConfig(name: string, args: EnvironmentAddonsConfigArgs, opts?: CustomResourceOptions);
    @overload
    def EnvironmentAddonsConfig(resource_name: str,
                                args: EnvironmentAddonsConfigArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnvironmentAddonsConfig(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                env_id: Optional[str] = None,
                                analytics_enabled: Optional[bool] = None)
    func NewEnvironmentAddonsConfig(ctx *Context, name string, args EnvironmentAddonsConfigArgs, opts ...ResourceOption) (*EnvironmentAddonsConfig, error)
    public EnvironmentAddonsConfig(string name, EnvironmentAddonsConfigArgs args, CustomResourceOptions? opts = null)
    public EnvironmentAddonsConfig(String name, EnvironmentAddonsConfigArgs args)
    public EnvironmentAddonsConfig(String name, EnvironmentAddonsConfigArgs args, CustomResourceOptions options)
    
    type: gcp:apigee:EnvironmentAddonsConfig
    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 EnvironmentAddonsConfigArgs
    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 EnvironmentAddonsConfigArgs
    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 EnvironmentAddonsConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentAddonsConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentAddonsConfigArgs
    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 environmentAddonsConfigResource = new Gcp.Apigee.EnvironmentAddonsConfig("environmentAddonsConfigResource", new()
    {
        EnvId = "string",
        AnalyticsEnabled = false,
    });
    
    example, err := apigee.NewEnvironmentAddonsConfig(ctx, "environmentAddonsConfigResource", &apigee.EnvironmentAddonsConfigArgs{
    	EnvId:            pulumi.String("string"),
    	AnalyticsEnabled: pulumi.Bool(false),
    })
    
    var environmentAddonsConfigResource = new EnvironmentAddonsConfig("environmentAddonsConfigResource", EnvironmentAddonsConfigArgs.builder()
        .envId("string")
        .analyticsEnabled(false)
        .build());
    
    environment_addons_config_resource = gcp.apigee.EnvironmentAddonsConfig("environmentAddonsConfigResource",
        env_id="string",
        analytics_enabled=False)
    
    const environmentAddonsConfigResource = new gcp.apigee.EnvironmentAddonsConfig("environmentAddonsConfigResource", {
        envId: "string",
        analyticsEnabled: false,
    });
    
    type: gcp:apigee:EnvironmentAddonsConfig
    properties:
        analyticsEnabled: false
        envId: string
    

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

    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    AnalyticsEnabled bool
    Flag to enable/disable Analytics.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    AnalyticsEnabled bool
    Flag to enable/disable Analytics.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled Boolean
    Flag to enable/disable Analytics.
    envId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled boolean
    Flag to enable/disable Analytics.
    env_id str
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analytics_enabled bool
    Flag to enable/disable Analytics.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled Boolean
    Flag to enable/disable Analytics.

    Outputs

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

    Get an existing EnvironmentAddonsConfig 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?: EnvironmentAddonsConfigState, opts?: CustomResourceOptions): EnvironmentAddonsConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            analytics_enabled: Optional[bool] = None,
            env_id: Optional[str] = None) -> EnvironmentAddonsConfig
    func GetEnvironmentAddonsConfig(ctx *Context, name string, id IDInput, state *EnvironmentAddonsConfigState, opts ...ResourceOption) (*EnvironmentAddonsConfig, error)
    public static EnvironmentAddonsConfig Get(string name, Input<string> id, EnvironmentAddonsConfigState? state, CustomResourceOptions? opts = null)
    public static EnvironmentAddonsConfig get(String name, Output<String> id, EnvironmentAddonsConfigState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apigee:EnvironmentAddonsConfig    get:      id: ${id}
    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:
    AnalyticsEnabled bool
    Flag to enable/disable Analytics.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    AnalyticsEnabled bool
    Flag to enable/disable Analytics.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled Boolean
    Flag to enable/disable Analytics.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled boolean
    Flag to enable/disable Analytics.
    envId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analytics_enabled bool
    Flag to enable/disable Analytics.
    env_id str
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    analyticsEnabled Boolean
    Flag to enable/disable Analytics.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.


    Import

    EnvironmentAddonsConfig can be imported using any of these accepted formats:

    • {{env_id}}

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

    $ pulumi import gcp:apigee/environmentAddonsConfig:EnvironmentAddonsConfig default {{env_id}}
    

    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 v8.18.0 published on Tuesday, Feb 4, 2025 by Pulumi