Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. CanaryEvaluation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.CanaryEvaluation

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new canary evaluation for an organization. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create CanaryEvaluation Resource

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

    Constructor syntax

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

@overload
def CanaryEvaluation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     control: Optional[str] = None,
                     end_time: Optional[str] = None,
                     instance_id: Optional[str] = None,
                     metric_labels: Optional[GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs] = None,
                     organization_id: Optional[str] = None,
                     start_time: Optional[str] = None,
                     treatment: Optional[str] = None)
    func NewCanaryEvaluation(ctx *Context, name string, args CanaryEvaluationArgs, opts ...ResourceOption) (*CanaryEvaluation, error)
    public CanaryEvaluation(string name, CanaryEvaluationArgs args, CustomResourceOptions? opts = null)
    public CanaryEvaluation(String name, CanaryEvaluationArgs args)
public CanaryEvaluation(String name, CanaryEvaluationArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:CanaryEvaluation
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 CanaryEvaluationArgs
    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 CanaryEvaluationArgs
    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 CanaryEvaluationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CanaryEvaluationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CanaryEvaluationArgs
    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 canaryEvaluationResource = new GoogleNative.Apigee.V1.CanaryEvaluation("canaryEvaluationResource", new()
{
    Control = "string",
    EndTime = "string",
    InstanceId = "string",
    MetricLabels = new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs
    {
        InstanceId = "string",
        Location = "string",
        Env = "string",
    },
    OrganizationId = "string",
    StartTime = "string",
    Treatment = "string",
});

    example, err := apigee.NewCanaryEvaluation(ctx, "canaryEvaluationResource", &apigee.CanaryEvaluationArgs{
	Control:    pulumi.String("string"),
	EndTime:    pulumi.String("string"),
	InstanceId: pulumi.String("string"),
	MetricLabels: &apigee.GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs{
		InstanceId: pulumi.String("string"),
		Location:   pulumi.String("string"),
		Env:        pulumi.String("string"),
	},
	OrganizationId: pulumi.String("string"),
	StartTime:      pulumi.String("string"),
	Treatment:      pulumi.String("string"),
})

    var canaryEvaluationResource = new CanaryEvaluation("canaryEvaluationResource", CanaryEvaluationArgs.builder()
    .control("string")
    .endTime("string")
    .instanceId("string")
    .metricLabels(GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs.builder()
        .instanceId("string")
        .location("string")
        .env("string")
        .build())
    .organizationId("string")
    .startTime("string")
    .treatment("string")
    .build());

    canary_evaluation_resource = google_native.apigee.v1.CanaryEvaluation("canaryEvaluationResource",
    control="string",
    end_time="string",
    instance_id="string",
    metric_labels={
        "instance_id": "string",
        "location": "string",
        "env": "string",
    },
    organization_id="string",
    start_time="string",
    treatment="string")

    const canaryEvaluationResource = new google_native.apigee.v1.CanaryEvaluation("canaryEvaluationResource", {
    control: "string",
    endTime: "string",
    instanceId: "string",
    metricLabels: {
        instanceId: "string",
        location: "string",
        env: "string",
    },
    organizationId: "string",
    startTime: "string",
    treatment: "string",
});

    type: google-native:apigee/v1:CanaryEvaluation
properties:
    control: string
    endTime: string
    instanceId: string
    metricLabels:
        env: string
        instanceId: string
        location: string
    organizationId: string
    startTime: string
    treatment: string

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

    Control string
    The stable version that is serving requests.
    EndTime string
    End time for the evaluation's analysis.
    InstanceId string
    MetricLabels Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1CanaryEvaluationMetricLabels
    Labels used to filter the metrics used for a canary evaluation.
    OrganizationId string
    StartTime string
    Start time for the canary evaluation's analysis.
    Treatment string
    The newer version that is serving requests.
    Control string
    The stable version that is serving requests.
    EndTime string
    End time for the evaluation's analysis.
    InstanceId string
    MetricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs
    Labels used to filter the metrics used for a canary evaluation.
    OrganizationId string
    StartTime string
    Start time for the canary evaluation's analysis.
    Treatment string
    The newer version that is serving requests.
    control String
    The stable version that is serving requests.
    endTime String
    End time for the evaluation's analysis.
    instanceId String
    metricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabels
    Labels used to filter the metrics used for a canary evaluation.
    organizationId String
    startTime String
    Start time for the canary evaluation's analysis.
    treatment String
    The newer version that is serving requests.
    control string
    The stable version that is serving requests.
    endTime string
    End time for the evaluation's analysis.
    instanceId string
    metricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabels
    Labels used to filter the metrics used for a canary evaluation.
    organizationId string
    startTime string
    Start time for the canary evaluation's analysis.
    treatment string
    The newer version that is serving requests.
    control str
    The stable version that is serving requests.
    end_time str
    End time for the evaluation's analysis.
    instance_id str
    metric_labels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs
    Labels used to filter the metrics used for a canary evaluation.
    organization_id str
    start_time str
    Start time for the canary evaluation's analysis.
    treatment str
    The newer version that is serving requests.
    control String
    The stable version that is serving requests.
    endTime String
    End time for the evaluation's analysis.
    instanceId String
    metricLabels Property Map
    Labels used to filter the metrics used for a canary evaluation.
    organizationId String
    startTime String
    Start time for the canary evaluation's analysis.
    treatment String
    The newer version that is serving requests.

    Outputs

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

    CreateTime string
    Create time of the canary evaluation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the canary evalution.
    State string
    The current state of the canary evaluation.
    Verdict string
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    CreateTime string
    Create time of the canary evaluation.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the canary evalution.
    State string
    The current state of the canary evaluation.
    Verdict string
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    createTime String
    Create time of the canary evaluation.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the canary evalution.
    state String
    The current state of the canary evaluation.
    verdict String
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    createTime string
    Create time of the canary evaluation.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the canary evalution.
    state string
    The current state of the canary evaluation.
    verdict string
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    create_time str
    Create time of the canary evaluation.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the canary evalution.
    state str
    The current state of the canary evaluation.
    verdict str
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    createTime String
    Create time of the canary evaluation.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the canary evalution.
    state String
    The current state of the canary evaluation.
    verdict String
    The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

    Supporting Types

    GoogleCloudApigeeV1CanaryEvaluationMetricLabels, GoogleCloudApigeeV1CanaryEvaluationMetricLabelsArgs

    InstanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    Location string
    The location associated with the metrics.
    Env string
    The environment ID associated with the metrics.
    InstanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    Location string
    The location associated with the metrics.
    Env string
    The environment ID associated with the metrics.
    instanceId String
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location String
    The location associated with the metrics.
    env String
    The environment ID associated with the metrics.
    instanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location string
    The location associated with the metrics.
    env string
    The environment ID associated with the metrics.
    instance_id str
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location str
    The location associated with the metrics.
    env str
    The environment ID associated with the metrics.
    instanceId String
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location String
    The location associated with the metrics.
    env String
    The environment ID associated with the metrics.

    GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse, GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponseArgs

    Env string
    The environment ID associated with the metrics.
    InstanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    Location string
    The location associated with the metrics.
    Env string
    The environment ID associated with the metrics.
    InstanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    Location string
    The location associated with the metrics.
    env String
    The environment ID associated with the metrics.
    instanceId String
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location String
    The location associated with the metrics.
    env string
    The environment ID associated with the metrics.
    instanceId string
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location string
    The location associated with the metrics.
    env str
    The environment ID associated with the metrics.
    instance_id str
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location str
    The location associated with the metrics.
    env String
    The environment ID associated with the metrics.
    instanceId String
    The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    location String
    The location associated with the metrics.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native