1. Packages
  2. Google Cloud Native
  3. API Docs
  4. workloadmanager
  5. workloadmanager/v1
  6. Evaluation

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

google-native.workloadmanager/v1.Evaluation

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

    Creates a new Evaluation in a given project and location. 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 Evaluation Resource

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

    Constructor syntax

    new Evaluation(name: string, args: EvaluationArgs, opts?: CustomResourceOptions);
    @overload
    def Evaluation(resource_name: str,
                   args: EvaluationArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Evaluation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   evaluation_id: Optional[str] = None,
                   custom_rules_bucket: Optional[str] = None,
                   description: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   request_id: Optional[str] = None,
                   resource_filter: Optional[ResourceFilterArgs] = None,
                   rule_names: Optional[Sequence[str]] = None,
                   schedule: Optional[str] = None)
    func NewEvaluation(ctx *Context, name string, args EvaluationArgs, opts ...ResourceOption) (*Evaluation, error)
    public Evaluation(string name, EvaluationArgs args, CustomResourceOptions? opts = null)
    public Evaluation(String name, EvaluationArgs args)
    public Evaluation(String name, EvaluationArgs args, CustomResourceOptions options)
    
    type: google-native:workloadmanager/v1:Evaluation
    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 EvaluationArgs
    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 EvaluationArgs
    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 EvaluationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EvaluationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EvaluationArgs
    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 google_nativeEvaluationResource = new GoogleNative.WorkloadManager.V1.Evaluation("google-nativeEvaluationResource", new()
    {
        EvaluationId = "string",
        CustomRulesBucket = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Name = "string",
        Project = "string",
        RequestId = "string",
        ResourceFilter = new GoogleNative.WorkloadManager.V1.Inputs.ResourceFilterArgs
        {
            GceInstanceFilter = new GoogleNative.WorkloadManager.V1.Inputs.GceInstanceFilterArgs
            {
                ServiceAccounts = new[]
                {
                    "string",
                },
            },
            InclusionLabels = 
            {
                { "string", "string" },
            },
            ResourceIdPatterns = new[]
            {
                "string",
            },
            Scopes = new[]
            {
                "string",
            },
        },
        RuleNames = new[]
        {
            "string",
        },
        Schedule = "string",
    });
    
    example, err := workloadmanager.NewEvaluation(ctx, "google-nativeEvaluationResource", &workloadmanager.EvaluationArgs{
    EvaluationId: pulumi.String("string"),
    CustomRulesBucket: pulumi.String("string"),
    Description: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    RequestId: pulumi.String("string"),
    ResourceFilter: &workloadmanager.ResourceFilterArgs{
    GceInstanceFilter: &workloadmanager.GceInstanceFilterArgs{
    ServiceAccounts: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    InclusionLabels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    ResourceIdPatterns: pulumi.StringArray{
    pulumi.String("string"),
    },
    Scopes: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    RuleNames: pulumi.StringArray{
    pulumi.String("string"),
    },
    Schedule: pulumi.String("string"),
    })
    
    var google_nativeEvaluationResource = new Evaluation("google-nativeEvaluationResource", EvaluationArgs.builder()
        .evaluationId("string")
        .customRulesBucket("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .name("string")
        .project("string")
        .requestId("string")
        .resourceFilter(ResourceFilterArgs.builder()
            .gceInstanceFilter(GceInstanceFilterArgs.builder()
                .serviceAccounts("string")
                .build())
            .inclusionLabels(Map.of("string", "string"))
            .resourceIdPatterns("string")
            .scopes("string")
            .build())
        .ruleNames("string")
        .schedule("string")
        .build());
    
    google_native_evaluation_resource = google_native.workloadmanager.v1.Evaluation("google-nativeEvaluationResource",
        evaluation_id="string",
        custom_rules_bucket="string",
        description="string",
        labels={
            "string": "string",
        },
        location="string",
        name="string",
        project="string",
        request_id="string",
        resource_filter=google_native.workloadmanager.v1.ResourceFilterArgs(
            gce_instance_filter=google_native.workloadmanager.v1.GceInstanceFilterArgs(
                service_accounts=["string"],
            ),
            inclusion_labels={
                "string": "string",
            },
            resource_id_patterns=["string"],
            scopes=["string"],
        ),
        rule_names=["string"],
        schedule="string")
    
    const google_nativeEvaluationResource = new google_native.workloadmanager.v1.Evaluation("google-nativeEvaluationResource", {
        evaluationId: "string",
        customRulesBucket: "string",
        description: "string",
        labels: {
            string: "string",
        },
        location: "string",
        name: "string",
        project: "string",
        requestId: "string",
        resourceFilter: {
            gceInstanceFilter: {
                serviceAccounts: ["string"],
            },
            inclusionLabels: {
                string: "string",
            },
            resourceIdPatterns: ["string"],
            scopes: ["string"],
        },
        ruleNames: ["string"],
        schedule: "string",
    });
    
    type: google-native:workloadmanager/v1:Evaluation
    properties:
        customRulesBucket: string
        description: string
        evaluationId: string
        labels:
            string: string
        location: string
        name: string
        project: string
        requestId: string
        resourceFilter:
            gceInstanceFilter:
                serviceAccounts:
                    - string
            inclusionLabels:
                string: string
            resourceIdPatterns:
                - string
            scopes:
                - string
        ruleNames:
            - string
        schedule: string
    

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

    EvaluationId string
    Required. Id of the requesting object
    CustomRulesBucket string
    The Cloud Storage bucket name for custom rules.
    Description string
    Description of the Evaluation
    Labels Dictionary<string, string>
    Labels as key value pairs
    Location string
    Name string
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    ResourceFilter Pulumi.GoogleNative.WorkloadManager.V1.Inputs.ResourceFilter
    annotations as key value pairs
    RuleNames List<string>
    the name of the rule
    Schedule string
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
    EvaluationId string
    Required. Id of the requesting object
    CustomRulesBucket string
    The Cloud Storage bucket name for custom rules.
    Description string
    Description of the Evaluation
    Labels map[string]string
    Labels as key value pairs
    Location string
    Name string
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    ResourceFilter ResourceFilterArgs
    annotations as key value pairs
    RuleNames []string
    the name of the rule
    Schedule string
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
    evaluationId String
    Required. Id of the requesting object
    customRulesBucket String
    The Cloud Storage bucket name for custom rules.
    description String
    Description of the Evaluation
    labels Map<String,String>
    Labels as key value pairs
    location String
    name String
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    resourceFilter ResourceFilter
    annotations as key value pairs
    ruleNames List<String>
    the name of the rule
    schedule String
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
    evaluationId string
    Required. Id of the requesting object
    customRulesBucket string
    The Cloud Storage bucket name for custom rules.
    description string
    Description of the Evaluation
    labels {[key: string]: string}
    Labels as key value pairs
    location string
    name string
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    project string
    requestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    resourceFilter ResourceFilter
    annotations as key value pairs
    ruleNames string[]
    the name of the rule
    schedule string
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
    evaluation_id str
    Required. Id of the requesting object
    custom_rules_bucket str
    The Cloud Storage bucket name for custom rules.
    description str
    Description of the Evaluation
    labels Mapping[str, str]
    Labels as key value pairs
    location str
    name str
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    project str
    request_id str
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    resource_filter ResourceFilterArgs
    annotations as key value pairs
    rule_names Sequence[str]
    the name of the rule
    schedule str
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",
    evaluationId String
    Required. Id of the requesting object
    customRulesBucket String
    The Cloud Storage bucket name for custom rules.
    description String
    Description of the Evaluation
    labels Map<String>
    Labels as key value pairs
    location String
    name String
    name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    resourceFilter Property Map
    annotations as key value pairs
    ruleNames List<String>
    the name of the rule
    schedule String
    crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *",

    Outputs

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

    CreateTime string
    [Output only] Create time stamp
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus Pulumi.GoogleNative.WorkloadManager.V1.Outputs.ResourceStatusResponse
    [Output only] The updated rule ids if exist.
    RuleVersions List<string>
    [Output only] The updated rule ids if exist.
    UpdateTime string
    [Output only] Update time stamp
    CreateTime string
    [Output only] Create time stamp
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus ResourceStatusResponse
    [Output only] The updated rule ids if exist.
    RuleVersions []string
    [Output only] The updated rule ids if exist.
    UpdateTime string
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus ResourceStatusResponse
    [Output only] The updated rule ids if exist.
    ruleVersions List<String>
    [Output only] The updated rule ids if exist.
    updateTime String
    [Output only] Update time stamp
    createTime string
    [Output only] Create time stamp
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus ResourceStatusResponse
    [Output only] The updated rule ids if exist.
    ruleVersions string[]
    [Output only] The updated rule ids if exist.
    updateTime string
    [Output only] Update time stamp
    create_time str
    [Output only] Create time stamp
    id str
    The provider-assigned unique ID for this managed resource.
    resource_status ResourceStatusResponse
    [Output only] The updated rule ids if exist.
    rule_versions Sequence[str]
    [Output only] The updated rule ids if exist.
    update_time str
    [Output only] Update time stamp
    createTime String
    [Output only] Create time stamp
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus Property Map
    [Output only] The updated rule ids if exist.
    ruleVersions List<String>
    [Output only] The updated rule ids if exist.
    updateTime String
    [Output only] Update time stamp

    Supporting Types

    GceInstanceFilter, GceInstanceFilterArgs

    ServiceAccounts List<string>
    Service account of compute engine
    ServiceAccounts []string
    Service account of compute engine
    serviceAccounts List<String>
    Service account of compute engine
    serviceAccounts string[]
    Service account of compute engine
    service_accounts Sequence[str]
    Service account of compute engine
    serviceAccounts List<String>
    Service account of compute engine

    GceInstanceFilterResponse, GceInstanceFilterResponseArgs

    ServiceAccounts List<string>
    Service account of compute engine
    ServiceAccounts []string
    Service account of compute engine
    serviceAccounts List<String>
    Service account of compute engine
    serviceAccounts string[]
    Service account of compute engine
    service_accounts Sequence[str]
    Service account of compute engine
    serviceAccounts List<String>
    Service account of compute engine

    ResourceFilter, ResourceFilterArgs

    GceInstanceFilter Pulumi.GoogleNative.WorkloadManager.V1.Inputs.GceInstanceFilter
    Filter compute engine resource
    InclusionLabels Dictionary<string, string>
    The label used for filter resource
    ResourceIdPatterns List<string>
    The id pattern for filter resource
    Scopes List<string>
    The scopes of evaluation resource
    GceInstanceFilter GceInstanceFilter
    Filter compute engine resource
    InclusionLabels map[string]string
    The label used for filter resource
    ResourceIdPatterns []string
    The id pattern for filter resource
    Scopes []string
    The scopes of evaluation resource
    gceInstanceFilter GceInstanceFilter
    Filter compute engine resource
    inclusionLabels Map<String,String>
    The label used for filter resource
    resourceIdPatterns List<String>
    The id pattern for filter resource
    scopes List<String>
    The scopes of evaluation resource
    gceInstanceFilter GceInstanceFilter
    Filter compute engine resource
    inclusionLabels {[key: string]: string}
    The label used for filter resource
    resourceIdPatterns string[]
    The id pattern for filter resource
    scopes string[]
    The scopes of evaluation resource
    gce_instance_filter GceInstanceFilter
    Filter compute engine resource
    inclusion_labels Mapping[str, str]
    The label used for filter resource
    resource_id_patterns Sequence[str]
    The id pattern for filter resource
    scopes Sequence[str]
    The scopes of evaluation resource
    gceInstanceFilter Property Map
    Filter compute engine resource
    inclusionLabels Map<String>
    The label used for filter resource
    resourceIdPatterns List<String>
    The id pattern for filter resource
    scopes List<String>
    The scopes of evaluation resource

    ResourceFilterResponse, ResourceFilterResponseArgs

    GceInstanceFilter Pulumi.GoogleNative.WorkloadManager.V1.Inputs.GceInstanceFilterResponse
    Filter compute engine resource
    InclusionLabels Dictionary<string, string>
    The label used for filter resource
    ResourceIdPatterns List<string>
    The id pattern for filter resource
    Scopes List<string>
    The scopes of evaluation resource
    GceInstanceFilter GceInstanceFilterResponse
    Filter compute engine resource
    InclusionLabels map[string]string
    The label used for filter resource
    ResourceIdPatterns []string
    The id pattern for filter resource
    Scopes []string
    The scopes of evaluation resource
    gceInstanceFilter GceInstanceFilterResponse
    Filter compute engine resource
    inclusionLabels Map<String,String>
    The label used for filter resource
    resourceIdPatterns List<String>
    The id pattern for filter resource
    scopes List<String>
    The scopes of evaluation resource
    gceInstanceFilter GceInstanceFilterResponse
    Filter compute engine resource
    inclusionLabels {[key: string]: string}
    The label used for filter resource
    resourceIdPatterns string[]
    The id pattern for filter resource
    scopes string[]
    The scopes of evaluation resource
    gce_instance_filter GceInstanceFilterResponse
    Filter compute engine resource
    inclusion_labels Mapping[str, str]
    The label used for filter resource
    resource_id_patterns Sequence[str]
    The id pattern for filter resource
    scopes Sequence[str]
    The scopes of evaluation resource
    gceInstanceFilter Property Map
    Filter compute engine resource
    inclusionLabels Map<String>
    The label used for filter resource
    resourceIdPatterns List<String>
    The id pattern for filter resource
    scopes List<String>
    The scopes of evaluation resource

    ResourceStatusResponse, ResourceStatusResponseArgs

    RulesNewerVersions List<string>
    Historical: Used before 2023-05-22 the new version of rule id if exists
    State string
    State of the resource
    RulesNewerVersions []string
    Historical: Used before 2023-05-22 the new version of rule id if exists
    State string
    State of the resource
    rulesNewerVersions List<String>
    Historical: Used before 2023-05-22 the new version of rule id if exists
    state String
    State of the resource
    rulesNewerVersions string[]
    Historical: Used before 2023-05-22 the new version of rule id if exists
    state string
    State of the resource
    rules_newer_versions Sequence[str]
    Historical: Used before 2023-05-22 the new version of rule id if exists
    state str
    State of the resource
    rulesNewerVersions List<String>
    Historical: Used before 2023-05-22 the new version of rule id if exists
    state String
    State of the resource

    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