Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. Override

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.Override

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 trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.

    Create Override Resource

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

    Constructor syntax

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

@overload
def Override(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             environment_id: Optional[str] = None,
             organization_id: Optional[str] = None,
             api_proxy: Optional[str] = None,
             name: Optional[str] = None,
             sampling_config: Optional[GoogleCloudApigeeV1TraceSamplingConfigArgs] = None)
    func NewOverride(ctx *Context, name string, args OverrideArgs, opts ...ResourceOption) (*Override, error)
    public Override(string name, OverrideArgs args, CustomResourceOptions? opts = null)
    public Override(String name, OverrideArgs args)
public Override(String name, OverrideArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:Override
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 OverrideArgs
    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 OverrideArgs
    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 OverrideArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OverrideArgs
    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 overrideResource = new GoogleNative.Apigee.V1.Override("overrideResource", new()
{
    EnvironmentId = "string",
    OrganizationId = "string",
    ApiProxy = "string",
    Name = "string",
    SamplingConfig = new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TraceSamplingConfigArgs
    {
        Sampler = GoogleNative.Apigee.V1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified,
        SamplingRate = 0,
    },
});

    example, err := apigee.NewOverride(ctx, "overrideResource", &apigee.OverrideArgs{
EnvironmentId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
ApiProxy: pulumi.String("string"),
Name: pulumi.String("string"),
SamplingConfig: &apigee.GoogleCloudApigeeV1TraceSamplingConfigArgs{
Sampler: apigee.GoogleCloudApigeeV1TraceSamplingConfigSamplerSamplerUnspecified,
SamplingRate: pulumi.Float64(0),
},
})

    var overrideResource = new Override("overrideResource", OverrideArgs.builder()        
    .environmentId("string")
    .organizationId("string")
    .apiProxy("string")
    .name("string")
    .samplingConfig(GoogleCloudApigeeV1TraceSamplingConfigArgs.builder()
        .sampler("SAMPLER_UNSPECIFIED")
        .samplingRate(0)
        .build())
    .build());

    override_resource = google_native.apigee.v1.Override("overrideResource",
    environment_id="string",
    organization_id="string",
    api_proxy="string",
    name="string",
    sampling_config=google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigArgs(
        sampler=google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SAMPLER_UNSPECIFIED,
        sampling_rate=0,
    ))

    const overrideResource = new google_native.apigee.v1.Override("overrideResource", {
    environmentId: "string",
    organizationId: "string",
    apiProxy: "string",
    name: "string",
    samplingConfig: {
        sampler: google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified,
        samplingRate: 0,
    },
});

    type: google-native:apigee/v1:Override
properties:
    apiProxy: string
    environmentId: string
    name: string
    organizationId: string
    samplingConfig:
        sampler: SAMPLER_UNSPECIFIED
        samplingRate: 0

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

    EnvironmentId string
    OrganizationId string
    ApiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    Name string
    ID of the trace configuration override specified as a system-generated UUID.
    SamplingConfig Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    EnvironmentId string
    OrganizationId string
    ApiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    Name string
    ID of the trace configuration override specified as a system-generated UUID.
    SamplingConfig GoogleCloudApigeeV1TraceSamplingConfigArgs
    Trace configuration to override.
    environmentId String
    organizationId String
    apiProxy String
    ID of the API proxy that will have its trace configuration overridden.
    name String
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    environmentId string
    organizationId string
    apiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    name string
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    environment_id str
    organization_id str
    api_proxy str
    ID of the API proxy that will have its trace configuration overridden.
    name str
    ID of the trace configuration override specified as a system-generated UUID.
    sampling_config GoogleCloudApigeeV1TraceSamplingConfigArgs
    Trace configuration to override.
    environmentId String
    organizationId String
    apiProxy String
    ID of the API proxy that will have its trace configuration overridden.
    name String
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig Property Map
    Trace configuration to override.

    Outputs

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

    Supporting Types

    GoogleCloudApigeeV1TraceSamplingConfig, GoogleCloudApigeeV1TraceSamplingConfigArgs

    Sampler Pulumi.GoogleNative.Apigee.V1.GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    Sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate float64
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    samplingRate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate float
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler "SAMPLER_UNSPECIFIED" | "OFF" | "PROBABILITY"
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.

    GoogleCloudApigeeV1TraceSamplingConfigResponse, GoogleCloudApigeeV1TraceSamplingConfigResponseArgs

    Sampler string
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    Sampler string
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate float64
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler String
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler string
    Sampler of distributed tracing. OFF is the default value.
    samplingRate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler str
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate float
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler String
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.

    GoogleCloudApigeeV1TraceSamplingConfigSampler, GoogleCloudApigeeV1TraceSamplingConfigSamplerArgs

    SamplerUnspecified
    SAMPLER_UNSPECIFIEDSampler unspecified.
    Off
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    Probability
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    GoogleCloudApigeeV1TraceSamplingConfigSamplerSamplerUnspecified
    SAMPLER_UNSPECIFIEDSampler unspecified.
    GoogleCloudApigeeV1TraceSamplingConfigSamplerOff
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    GoogleCloudApigeeV1TraceSamplingConfigSamplerProbability
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    SamplerUnspecified
    SAMPLER_UNSPECIFIEDSampler unspecified.
    Off
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    Probability
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    SamplerUnspecified
    SAMPLER_UNSPECIFIEDSampler unspecified.
    Off
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    Probability
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    SAMPLER_UNSPECIFIED
    SAMPLER_UNSPECIFIEDSampler unspecified.
    OFF
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    PROBABILITY
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    "SAMPLER_UNSPECIFIED"
    SAMPLER_UNSPECIFIEDSampler unspecified.
    "OFF"
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    "PROBABILITY"
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.

    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