This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
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.
resource "google-native_apigee_v1_override" "name" {
# resource properties
}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.
Constructor 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.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),
},
})
resource "google-native_apigee_v1_override" "overrideResource" {
lifecycle {
create_before_destroy = true
}
environment_id = "string"
organization_id = "string"
api_proxy = "string"
name = "string"
sampling_config = {
sampler = "SAMPLER_UNSPECIFIED"
sampling_rate = 0
}
}
var overrideResource = new Override("overrideResource", OverrideArgs.builder()
.environmentId("string")
.organizationId("string")
.apiProxy("string")
.name("string")
.samplingConfig(GoogleCloudApigeeV1TraceSamplingConfigArgs.builder()
.sampler(com.pulumi.googlenative.apigee_v1.enums.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified)
.samplingRate(0.0)
.build())
.build());
override_resource = google_native.apigee.v1.Override("overrideResource",
environment_id="string",
organization_id="string",
api_proxy="string",
name="string",
sampling_config={
"sampler": google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SAMPLER_UNSPECIFIED,
"sampling_rate": float(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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Override resource accepts the following input properties:
- Environment
Id string - Organization
Id string - Api
Proxy 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.
- Sampling
Config Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Trace Sampling Config - Trace configuration to override.
- Environment
Id string - Organization
Id string - Api
Proxy 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.
- Sampling
Config GoogleCloud Apigee V1Trace Sampling Config Args - Trace configuration to override.
- environment_
id string - organization_
id string - api_
proxy 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.
- sampling_
config object - Trace configuration to override.
- environment
Id String - organization
Id String - api
Proxy 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.
- sampling
Config GoogleCloud Apigee V1Trace Sampling Config - Trace configuration to override.
- environment
Id string - organization
Id string - api
Proxy 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.
- sampling
Config GoogleCloud Apigee V1Trace Sampling Config - 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 GoogleCloud Apigee V1Trace Sampling Config Args - Trace configuration to override.
- environment
Id String - organization
Id String - api
Proxy 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.
- sampling
Config 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 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 Override Resource
Get an existing Override 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>, opts?: CustomResourceOptions): Override@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Overridefunc GetOverride(ctx *Context, name string, id IDInput, state *OverrideState, opts ...ResourceOption) (*Override, error)public static Override Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Override get(String name, Output<String> id, CustomResourceOptions options)resources: existingOverride: type: google-native:apigee/v1:Override get: id: ${id}import {
to = google-native_apigee_v1_override.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state OverrideState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
GoogleCloudApigeeV1TraceSamplingConfig, GoogleCloudApigeeV1TraceSamplingConfigArgs
TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.- Sampler
Pulumi.
Google Native. Apigee. V1. Google Cloud Apigee V1Trace Sampling Config Sampler - Sampler of distributed tracing. OFF is the default value.
- Sampling
Rate double - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
- Sampler
Google
Cloud Apigee V1Trace Sampling Config Sampler - Sampler of distributed tracing. OFF is the default value.
- Sampling
Rate float64 - 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.
- sampling_
rate number - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
- sampler
Google
Cloud Apigee V1Trace Sampling Config Sampler - Sampler of distributed tracing. OFF is the default value.
- sampling
Rate Double - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
- sampler
Google
Cloud Apigee V1Trace Sampling Config Sampler - Sampler of distributed tracing. OFF is the default value.
- sampling
Rate number - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
- sampler
Google
Cloud Apigee V1Trace Sampling Config Sampler - 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.
- sampling
Rate Number - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
GoogleCloudApigeeV1TraceSamplingConfigResponse, GoogleCloudApigeeV1TraceSamplingConfigResponseArgs
TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.- Sampler string
- Sampler of distributed tracing. OFF is the default value.
- Sampling
Rate 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.
- Sampling
Rate 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.
- sampling_
rate number - 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.
- sampling
Rate 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.
- sampling
Rate 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.
- sampling
Rate Number - Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
GoogleCloudApigeeV1TraceSamplingConfigSampler, GoogleCloudApigeeV1TraceSamplingConfigSamplerArgs
Sampler of distributed tracing. OFF is the default value.| Name | Value | Description |
|---|---|---|
| Sampler | SAMPLER_UNSPECIFIED | Sampler unspecified. |
| Off | OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
| Probability | PROBABILITY | PROBABILITY 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. |
| Name | Value | Description |
|---|---|---|
| Google | SAMPLER_UNSPECIFIED | Sampler unspecified. |
| Google | OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
| Google | PROBABILITY | PROBABILITY 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. |
| Value | Description |
|---|---|
SAMPLER_UNSPECIFIED | Sampler unspecified. |
OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
PROBABILITY | PROBABILITY 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. |
| Name | Value | Description |
|---|---|---|
| Sampler | SAMPLER_UNSPECIFIED | Sampler unspecified. |
| Off | OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
| Probability | PROBABILITY | PROBABILITY 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. |
| Name | Value | Description |
|---|---|---|
| Sampler | SAMPLER_UNSPECIFIED | Sampler unspecified. |
| Off | OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
| Probability | PROBABILITY | PROBABILITY 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. |
| Name | Value | Description |
|---|---|---|
| SAMPLER_UNSPECIFIED | SAMPLER_UNSPECIFIED | Sampler unspecified. |
| OFF | OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
| PROBABILITY | PROBABILITY | PROBABILITY 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. |
| Value | Description |
|---|---|
SAMPLER_UNSPECIFIED | Sampler unspecified. |
OFF | OFF means distributed trace is disabled, or the sampling probability is 0. |
PROBABILITY | PROBABILITY 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
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi