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

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

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 an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the name query parameter to the name of the API proxy. * Set the action query parameter to import. * Set the Content-Type header to multipart/form-data. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

    Create Api Resource

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

    Constructor syntax

    new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
    @overload
    def Api(resource_name: str,
            args: ApiArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Api(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            organization_id: Optional[str] = None,
            action: Optional[str] = None,
            content_type: Optional[str] = None,
            data: Optional[str] = None,
            extensions: Optional[Sequence[Mapping[str, str]]] = None,
            file: Optional[Union[pulumi.Asset, pulumi.Archive]] = None,
            name: Optional[str] = None,
            validate: Optional[bool] = None)
    func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
    public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
    public Api(String name, ApiArgs args)
    public Api(String name, ApiArgs args, CustomResourceOptions options)
    
    type: google-native:apigee/v1:Api
    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 ApiArgs
    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 ApiArgs
    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 ApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiArgs
    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 exampleapiResourceResourceFromApigeev1 = new GoogleNative.Apigee.V1.Api("exampleapiResourceResourceFromApigeev1", new()
    {
        OrganizationId = "string",
        Action = "string",
        ContentType = "string",
        Data = "string",
        Extensions = new[]
        {
            
            {
                { "string", "string" },
            },
        },
        File = new StringAsset("content"),
        Name = "string",
        Validate = false,
    });
    
    example, err := apigee.NewApi(ctx, "exampleapiResourceResourceFromApigeev1", &apigee.ApiArgs{
    OrganizationId: pulumi.String("string"),
    Action: pulumi.String("string"),
    ContentType: pulumi.String("string"),
    Data: pulumi.String("string"),
    Extensions: pulumi.StringMapArray{
    pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    },
    File: pulumi.NewStringAsset("content"),
    Name: pulumi.String("string"),
    Validate: pulumi.Bool(false),
    })
    
    var exampleapiResourceResourceFromApigeev1 = new Api("exampleapiResourceResourceFromApigeev1", ApiArgs.builder()
        .organizationId("string")
        .action("string")
        .contentType("string")
        .data("string")
        .extensions(Map.of("string", "string"))
        .file(new StringAsset("content"))
        .name("string")
        .validate(false)
        .build());
    
    exampleapi_resource_resource_from_apigeev1 = google_native.apigee.v1.Api("exampleapiResourceResourceFromApigeev1",
        organization_id="string",
        action="string",
        content_type="string",
        data="string",
        extensions=[{
            "string": "string",
        }],
        file=pulumi.StringAsset("content"),
        name="string",
        validate=False)
    
    const exampleapiResourceResourceFromApigeev1 = new google_native.apigee.v1.Api("exampleapiResourceResourceFromApigeev1", {
        organizationId: "string",
        action: "string",
        contentType: "string",
        data: "string",
        extensions: [{
            string: "string",
        }],
        file: new pulumi.asset.StringAsset("content"),
        name: "string",
        validate: false,
    });
    
    type: google-native:apigee/v1:Api
    properties:
        action: string
        contentType: string
        data: string
        extensions:
            - string: string
        file:
            fn::StringAsset: content
        name: string
        organizationId: string
        validate: false
    

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

    OrganizationId string
    Action string
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    ContentType string
    The HTTP Content-Type header value specifying the content type of the body.
    Data string
    The HTTP request/response body as raw binary.
    Extensions List<ImmutableDictionary<string, string>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    File AssetOrArchive
    File to upload.
    Name string
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    Validate bool
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
    OrganizationId string
    Action string
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    ContentType string
    The HTTP Content-Type header value specifying the content type of the body.
    Data string
    The HTTP request/response body as raw binary.
    Extensions []map[string]string
    Application specific response metadata. Must be set in the first response for streaming APIs.
    File pulumi.AssetOrArchive
    File to upload.
    Name string
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    Validate bool
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
    organizationId String
    action String
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    contentType String
    The HTTP Content-Type header value specifying the content type of the body.
    data String
    The HTTP request/response body as raw binary.
    extensions List<Map<String,String>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file AssetOrArchive
    File to upload.
    name String
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    validate Boolean
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
    organizationId string
    action string
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    contentType string
    The HTTP Content-Type header value specifying the content type of the body.
    data string
    The HTTP request/response body as raw binary.
    extensions {[key: string]: string}[]
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file pulumi.asset.Asset | pulumi.asset.Archive
    File to upload.
    name string
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    validate boolean
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
    organization_id str
    action str
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    content_type str
    The HTTP Content-Type header value specifying the content type of the body.
    data str
    The HTTP request/response body as raw binary.
    extensions Sequence[Mapping[str, str]]
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file Union[pulumi.Asset, pulumi.Archive]
    File to upload.
    name str
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    validate bool
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
    organizationId String
    action String
    Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * import to import the API proxy configuration bundle. * validate to validate the API proxy configuration bundle without importing it.
    contentType String
    The HTTP Content-Type header value specifying the content type of the body.
    data String
    The HTTP request/response body as raw binary.
    extensions List<Map<String>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file Asset
    File to upload.
    name String
    Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
    validate Boolean
    Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.

    Outputs

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

    ApiProxyType string
    The type of the API proxy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, string>
    User labels applied to this API Proxy.
    LatestRevisionId string
    The id of the most recently created revision for this api proxy.
    MetaData Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1EntityMetadataResponse
    Metadata describing the API proxy.
    ReadOnly bool
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    Revision List<string>
    List of revisions defined for the API proxy.
    ApiProxyType string
    The type of the API proxy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]string
    User labels applied to this API Proxy.
    LatestRevisionId string
    The id of the most recently created revision for this api proxy.
    MetaData GoogleCloudApigeeV1EntityMetadataResponse
    Metadata describing the API proxy.
    ReadOnly bool
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    Revision []string
    List of revisions defined for the API proxy.
    apiProxyType String
    The type of the API proxy.
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,String>
    User labels applied to this API Proxy.
    latestRevisionId String
    The id of the most recently created revision for this api proxy.
    metaData GoogleCloudApigeeV1EntityMetadataResponse
    Metadata describing the API proxy.
    readOnly Boolean
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    revision List<String>
    List of revisions defined for the API proxy.
    apiProxyType string
    The type of the API proxy.
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: string}
    User labels applied to this API Proxy.
    latestRevisionId string
    The id of the most recently created revision for this api proxy.
    metaData GoogleCloudApigeeV1EntityMetadataResponse
    Metadata describing the API proxy.
    readOnly boolean
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    revision string[]
    List of revisions defined for the API proxy.
    api_proxy_type str
    The type of the API proxy.
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, str]
    User labels applied to this API Proxy.
    latest_revision_id str
    The id of the most recently created revision for this api proxy.
    meta_data GoogleCloudApigeeV1EntityMetadataResponse
    Metadata describing the API proxy.
    read_only bool
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    revision Sequence[str]
    List of revisions defined for the API proxy.
    apiProxyType String
    The type of the API proxy.
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String>
    User labels applied to this API Proxy.
    latestRevisionId String
    The id of the most recently created revision for this api proxy.
    metaData Property Map
    Metadata describing the API proxy.
    readOnly Boolean
    Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
    revision List<String>
    List of revisions defined for the API proxy.

    Supporting Types

    GoogleCloudApigeeV1EntityMetadataResponse, GoogleCloudApigeeV1EntityMetadataResponseArgs

    CreatedAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    LastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    SubType string
    The type of entity described
    CreatedAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    LastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    SubType string
    The type of entity described
    createdAt String
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt String
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType String
    The type of entity described
    createdAt string
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt string
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType string
    The type of entity described
    created_at str
    Time at which the API proxy was created, in milliseconds since epoch.
    last_modified_at str
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    sub_type str
    The type of entity described
    createdAt String
    Time at which the API proxy was created, in milliseconds since epoch.
    lastModifiedAt String
    Time at which the API proxy was most recently modified, in milliseconds since epoch.
    subType String
    The type of entity described

    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