1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. Subscriber
Oracle Cloud Infrastructure v1.37.0 published on Friday, May 24, 2024 by Pulumi

oci.ApiGateway.Subscriber

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.37.0 published on Friday, May 24, 2024 by Pulumi

    This resource provides the Subscriber resource in Oracle Cloud Infrastructure API Gateway service.

    Creates a new subscriber.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSubscriber = new oci.apigateway.Subscriber("test_subscriber", {
        clients: [{
            name: subscriberClientsName,
            token: subscriberClientsToken,
        }],
        compartmentId: compartmentId,
        usagePlans: subscriberUsagePlans,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: subscriberDisplayName,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_subscriber = oci.api_gateway.Subscriber("test_subscriber",
        clients=[oci.api_gateway.SubscriberClientArgs(
            name=subscriber_clients_name,
            token=subscriber_clients_token,
        )],
        compartment_id=compartment_id,
        usage_plans=subscriber_usage_plans,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=subscriber_display_name,
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/ApiGateway"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ApiGateway.NewSubscriber(ctx, "test_subscriber", &ApiGateway.SubscriberArgs{
    			Clients: apigateway.SubscriberClientArray{
    				&apigateway.SubscriberClientArgs{
    					Name:  pulumi.Any(subscriberClientsName),
    					Token: pulumi.Any(subscriberClientsToken),
    				},
    			},
    			CompartmentId: pulumi.Any(compartmentId),
    			UsagePlans:    pulumi.Any(subscriberUsagePlans),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(subscriberDisplayName),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testSubscriber = new Oci.ApiGateway.Subscriber("test_subscriber", new()
        {
            Clients = new[]
            {
                new Oci.ApiGateway.Inputs.SubscriberClientArgs
                {
                    Name = subscriberClientsName,
                    Token = subscriberClientsToken,
                },
            },
            CompartmentId = compartmentId,
            UsagePlans = subscriberUsagePlans,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = subscriberDisplayName,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ApiGateway.Subscriber;
    import com.pulumi.oci.ApiGateway.SubscriberArgs;
    import com.pulumi.oci.ApiGateway.inputs.SubscriberClientArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testSubscriber = new Subscriber("testSubscriber", SubscriberArgs.builder()
                .clients(SubscriberClientArgs.builder()
                    .name(subscriberClientsName)
                    .token(subscriberClientsToken)
                    .build())
                .compartmentId(compartmentId)
                .usagePlans(subscriberUsagePlans)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(subscriberDisplayName)
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testSubscriber:
        type: oci:ApiGateway:Subscriber
        name: test_subscriber
        properties:
          clients:
            - name: ${subscriberClientsName}
              token: ${subscriberClientsToken}
          compartmentId: ${compartmentId}
          usagePlans: ${subscriberUsagePlans}
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${subscriberDisplayName}
          freeformTags:
            Department: Finance
    

    Create Subscriber Resource

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

    Constructor syntax

    new Subscriber(name: string, args: SubscriberArgs, opts?: CustomResourceOptions);
    @overload
    def Subscriber(resource_name: str,
                   args: SubscriberArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Subscriber(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   clients: Optional[Sequence[_apigateway.SubscriberClientArgs]] = None,
                   compartment_id: Optional[str] = None,
                   usage_plans: Optional[Sequence[str]] = None,
                   defined_tags: Optional[Mapping[str, Any]] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewSubscriber(ctx *Context, name string, args SubscriberArgs, opts ...ResourceOption) (*Subscriber, error)
    public Subscriber(string name, SubscriberArgs args, CustomResourceOptions? opts = null)
    public Subscriber(String name, SubscriberArgs args)
    public Subscriber(String name, SubscriberArgs args, CustomResourceOptions options)
    
    type: oci:ApiGateway:Subscriber
    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 SubscriberArgs
    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 SubscriberArgs
    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 SubscriberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriberArgs
    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 subscriberResource = new Oci.ApiGateway.Subscriber("subscriberResource", new()
    {
        Clients = new[]
        {
            new Oci.ApiGateway.Inputs.SubscriberClientArgs
            {
                Name = "string",
                Token = "string",
            },
        },
        CompartmentId = "string",
        UsagePlans = new[]
        {
            "string",
        },
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := ApiGateway.NewSubscriber(ctx, "subscriberResource", &ApiGateway.SubscriberArgs{
    	Clients: apigateway.SubscriberClientArray{
    		&apigateway.SubscriberClientArgs{
    			Name:  pulumi.String("string"),
    			Token: pulumi.String("string"),
    		},
    	},
    	CompartmentId: pulumi.String("string"),
    	UsagePlans: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var subscriberResource = new Subscriber("subscriberResource", SubscriberArgs.builder()        
        .clients(SubscriberClientArgs.builder()
            .name("string")
            .token("string")
            .build())
        .compartmentId("string")
        .usagePlans("string")
        .definedTags(Map.of("string", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .build());
    
    subscriber_resource = oci.api_gateway.Subscriber("subscriberResource",
        clients=[oci.api_gateway.SubscriberClientArgs(
            name="string",
            token="string",
        )],
        compartment_id="string",
        usage_plans=["string"],
        defined_tags={
            "string": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        })
    
    const subscriberResource = new oci.apigateway.Subscriber("subscriberResource", {
        clients: [{
            name: "string",
            token: "string",
        }],
        compartmentId: "string",
        usagePlans: ["string"],
        definedTags: {
            string: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:ApiGateway:Subscriber
    properties:
        clients:
            - name: string
              token: string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        usagePlans:
            - string
    

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

    Clients List<SubscriberClient>
    (Updatable) The clients belonging to this subscriber.
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    UsagePlans List<string>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Clients []SubscriberClientArgs
    (Updatable) The clients belonging to this subscriber.
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    UsagePlans []string

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    clients List<SubscriberClient>
    (Updatable) The clients belonging to this subscriber.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    usagePlans List<String>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    clients SubscriberClient[]
    (Updatable) The clients belonging to this subscriber.
    compartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    usagePlans string[]

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    clients Sequence[apigateway.SubscriberClientArgs]
    (Updatable) The clients belonging to this subscriber.
    compartment_id str
    (Updatable) The OCID of the compartment in which the resource is created.
    usage_plans Sequence[str]

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    clients List<Property Map>
    (Updatable) The clients belonging to this subscriber.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    usagePlans List<String>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the subscriber.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the subscriber.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the subscriber.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state string
    The current state of the subscriber.
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state str
    The current state of the subscriber.
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the subscriber.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.

    Look up Existing Subscriber Resource

    Get an existing Subscriber 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>, state?: SubscriberState, opts?: CustomResourceOptions): Subscriber
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            clients: Optional[Sequence[_apigateway.SubscriberClientArgs]] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_details: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            usage_plans: Optional[Sequence[str]] = None) -> Subscriber
    func GetSubscriber(ctx *Context, name string, id IDInput, state *SubscriberState, opts ...ResourceOption) (*Subscriber, error)
    public static Subscriber Get(string name, Input<string> id, SubscriberState? state, CustomResourceOptions? opts = null)
    public static Subscriber get(String name, Output<String> id, SubscriberState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Clients List<SubscriberClient>
    (Updatable) The clients belonging to this subscriber.
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the subscriber.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    UsagePlans List<string>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Clients []SubscriberClientArgs
    (Updatable) The clients belonging to this subscriber.
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the subscriber.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    UsagePlans []string

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    clients List<SubscriberClient>
    (Updatable) The clients belonging to this subscriber.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the subscriber.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    usagePlans List<String>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    clients SubscriberClient[]
    (Updatable) The clients belonging to this subscriber.
    compartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state string
    The current state of the subscriber.
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    usagePlans string[]

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    clients Sequence[apigateway.SubscriberClientArgs]
    (Updatable) The clients belonging to this subscriber.
    compartment_id str
    (Updatable) The OCID of the compartment in which the resource is created.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state str
    The current state of the subscriber.
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    usage_plans Sequence[str]

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    clients List<Property Map>
    (Updatable) The clients belonging to this subscriber.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the subscriber.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    usagePlans List<String>

    (Updatable) An array of OCIDs of usage plan resources.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    SubscriberClient, SubscriberClientArgs

    Name string
    (Updatable) The name of the client. Must be unique within a subscriber.
    Token string
    (Updatable) The token for the client. Must be unique within a tenancy.
    Name string
    (Updatable) The name of the client. Must be unique within a subscriber.
    Token string
    (Updatable) The token for the client. Must be unique within a tenancy.
    name String
    (Updatable) The name of the client. Must be unique within a subscriber.
    token String
    (Updatable) The token for the client. Must be unique within a tenancy.
    name string
    (Updatable) The name of the client. Must be unique within a subscriber.
    token string
    (Updatable) The token for the client. Must be unique within a tenancy.
    name str
    (Updatable) The name of the client. Must be unique within a subscriber.
    token str
    (Updatable) The token for the client. Must be unique within a tenancy.
    name String
    (Updatable) The name of the client. Must be unique within a subscriber.
    token String
    (Updatable) The token for the client. Must be unique within a tenancy.

    Import

    Subscribers can be imported using the id, e.g.

    $ pulumi import oci:ApiGateway/subscriber:Subscriber test_subscriber "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.37.0 published on Friday, May 24, 2024 by Pulumi