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

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.apigee/v1.DebugSession

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 debug session for a deployed API Proxy revision. 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 DebugSession Resource

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

    Constructor syntax

    new DebugSession(name: string, args: DebugSessionArgs, opts?: CustomResourceOptions);
    @overload
    def DebugSession(resource_name: str,
                     args: DebugSessionArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def DebugSession(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_id: Optional[str] = None,
                     environment_id: Optional[str] = None,
                     organization_id: Optional[str] = None,
                     revision_id: Optional[str] = None,
                     count: Optional[int] = None,
                     filter: Optional[str] = None,
                     name: Optional[str] = None,
                     timeout: Optional[str] = None,
                     tracesize: Optional[int] = None,
                     validity: Optional[int] = None)
    func NewDebugSession(ctx *Context, name string, args DebugSessionArgs, opts ...ResourceOption) (*DebugSession, error)
    public DebugSession(string name, DebugSessionArgs args, CustomResourceOptions? opts = null)
    public DebugSession(String name, DebugSessionArgs args)
    public DebugSession(String name, DebugSessionArgs args, CustomResourceOptions options)
    
    type: google-native:apigee/v1:DebugSession
    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 DebugSessionArgs
    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 DebugSessionArgs
    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 DebugSessionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DebugSessionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DebugSessionArgs
    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 debugSessionResource = new GoogleNative.Apigee.V1.DebugSession("debugSessionResource", new()
    {
        ApiId = "string",
        EnvironmentId = "string",
        OrganizationId = "string",
        RevisionId = "string",
        Count = 0,
        Filter = "string",
        Name = "string",
        Timeout = "string",
        Tracesize = 0,
        Validity = 0,
    });
    
    example, err := apigee.NewDebugSession(ctx, "debugSessionResource", &apigee.DebugSessionArgs{
    ApiId: pulumi.String("string"),
    EnvironmentId: pulumi.String("string"),
    OrganizationId: pulumi.String("string"),
    RevisionId: pulumi.String("string"),
    Count: pulumi.Int(0),
    Filter: pulumi.String("string"),
    Name: pulumi.String("string"),
    Timeout: pulumi.String("string"),
    Tracesize: pulumi.Int(0),
    Validity: pulumi.Int(0),
    })
    
    var debugSessionResource = new DebugSession("debugSessionResource", DebugSessionArgs.builder()
        .apiId("string")
        .environmentId("string")
        .organizationId("string")
        .revisionId("string")
        .count(0)
        .filter("string")
        .name("string")
        .timeout("string")
        .tracesize(0)
        .validity(0)
        .build());
    
    debug_session_resource = google_native.apigee.v1.DebugSession("debugSessionResource",
        api_id="string",
        environment_id="string",
        organization_id="string",
        revision_id="string",
        count=0,
        filter="string",
        name="string",
        timeout="string",
        tracesize=0,
        validity=0)
    
    const debugSessionResource = new google_native.apigee.v1.DebugSession("debugSessionResource", {
        apiId: "string",
        environmentId: "string",
        organizationId: "string",
        revisionId: "string",
        count: 0,
        filter: "string",
        name: "string",
        timeout: "string",
        tracesize: 0,
        validity: 0,
    });
    
    type: google-native:apigee/v1:DebugSession
    properties:
        apiId: string
        count: 0
        environmentId: string
        filter: string
        name: string
        organizationId: string
        revisionId: string
        timeout: string
        tracesize: 0
        validity: 0
    

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

    ApiId string
    EnvironmentId string
    OrganizationId string
    RevisionId string
    Count int
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    Filter string
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    Name string
    A unique ID for this DebugSession.
    Timeout string
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    Tracesize int
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    Validity int
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
    ApiId string
    EnvironmentId string
    OrganizationId string
    RevisionId string
    Count int
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    Filter string
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    Name string
    A unique ID for this DebugSession.
    Timeout string
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    Tracesize int
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    Validity int
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
    apiId String
    environmentId String
    organizationId String
    revisionId String
    count Integer
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    filter String
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    name String
    A unique ID for this DebugSession.
    timeout String
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    tracesize Integer
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    validity Integer
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
    apiId string
    environmentId string
    organizationId string
    revisionId string
    count number
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    filter string
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    name string
    A unique ID for this DebugSession.
    timeout string
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    tracesize number
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    validity number
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
    api_id str
    environment_id str
    organization_id str
    revision_id str
    count int
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    filter str
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    name str
    A unique ID for this DebugSession.
    timeout str
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    tracesize int
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    validity int
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.
    apiId String
    environmentId String
    organizationId String
    revisionId String
    count Number
    Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
    filter String
    Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
    name String
    A unique ID for this DebugSession.
    timeout String
    Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
    tracesize Number
    Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
    validity Number
    Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

    Outputs

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

    CreateTime string
    The first transaction creation timestamp, recorded by UAP.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    The first transaction creation timestamp, recorded by UAP.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    The first transaction creation timestamp, recorded by UAP.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    The first transaction creation timestamp, recorded by UAP.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    The first transaction creation timestamp, recorded by UAP.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    The first transaction creation timestamp, recorded by UAP.
    id String
    The provider-assigned unique ID for this managed 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