Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. apigateway
  5. getSdk

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.apigateway.getSdk

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.apigateway.getSdk({
    restApiId: exampleAwsApiGatewayStage.restApiId,
    stageName: exampleAwsApiGatewayStage.stageName,
    sdkType: "android",
    parameters: {
        groupId: "example",
        artifactId: "example",
        artifactVersion: "example",
        invokerPackage: "example",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.apigateway.get_sdk(rest_api_id=example_aws_api_gateway_stage["restApiId"],
    stage_name=example_aws_api_gateway_stage["stageName"],
    sdk_type="android",
    parameters={
        "groupId": "example",
        "artifactId": "example",
        "artifactVersion": "example",
        "invokerPackage": "example",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetSdk(ctx, &apigateway.GetSdkArgs{
			RestApiId: exampleAwsApiGatewayStage.RestApiId,
			StageName: exampleAwsApiGatewayStage.StageName,
			SdkType:   "android",
			Parameters: map[string]interface{}{
				"groupId":         "example",
				"artifactId":      "example",
				"artifactVersion": "example",
				"invokerPackage":  "example",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.ApiGateway.GetSdk.Invoke(new()
    {
        RestApiId = exampleAwsApiGatewayStage.RestApiId,
        StageName = exampleAwsApiGatewayStage.StageName,
        SdkType = "android",
        Parameters = 
        {
            { "groupId", "example" },
            { "artifactId", "example" },
            { "artifactVersion", "example" },
            { "invokerPackage", "example" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetSdkArgs;
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) {
        final var example = ApigatewayFunctions.getSdk(GetSdkArgs.builder()
            .restApiId(exampleAwsApiGatewayStage.restApiId())
            .stageName(exampleAwsApiGatewayStage.stageName())
            .sdkType("android")
            .parameters(Map.ofEntries(
                Map.entry("groupId", "example"),
                Map.entry("artifactId", "example"),
                Map.entry("artifactVersion", "example"),
                Map.entry("invokerPackage", "example")
            ))
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:apigateway:getSdk
      Arguments:
        restApiId: ${exampleAwsApiGatewayStage.restApiId}
        stageName: ${exampleAwsApiGatewayStage.stageName}
        sdkType: android
        parameters:
          groupId: example
          artifactId: example
          artifactVersion: example
          invokerPackage: example

    Using getSdk

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSdk(args: GetSdkArgs, opts?: InvokeOptions): Promise<GetSdkResult>
function getSdkOutput(args: GetSdkOutputArgs, opts?: InvokeOptions): Output<GetSdkResult>
    def get_sdk(parameters: Optional[Mapping[str, str]] = None,
            rest_api_id: Optional[str] = None,
            sdk_type: Optional[str] = None,
            stage_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetSdkResult
def get_sdk_output(parameters: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            rest_api_id: Optional[pulumi.Input[str]] = None,
            sdk_type: Optional[pulumi.Input[str]] = None,
            stage_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetSdkResult]
    func GetSdk(ctx *Context, args *GetSdkArgs, opts ...InvokeOption) (*GetSdkResult, error)
func GetSdkOutput(ctx *Context, args *GetSdkOutputArgs, opts ...InvokeOption) GetSdkResultOutput

    > Note: This function is named GetSdk in the Go SDK.

    public static class GetSdk 
{
    public static Task<GetSdkResult> InvokeAsync(GetSdkArgs args, InvokeOptions? opts = null)
    public static Output<GetSdkResult> Invoke(GetSdkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSdkResult> getSdk(GetSdkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:apigateway/getSdk:getSdk
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RestApiId string
    Identifier of the associated REST API.
    SdkType string
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    StageName string
    Name of the Stage that will be exported.
    Parameters Dictionary<string, string>
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.
    RestApiId string
    Identifier of the associated REST API.
    SdkType string
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    StageName string
    Name of the Stage that will be exported.
    Parameters map[string]string
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.
    restApiId String
    Identifier of the associated REST API.
    sdkType String
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    stageName String
    Name of the Stage that will be exported.
    parameters Map<String,String>
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.
    restApiId string
    Identifier of the associated REST API.
    sdkType string
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    stageName string
    Name of the Stage that will be exported.
    parameters {[key: string]: string}
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.
    rest_api_id str
    Identifier of the associated REST API.
    sdk_type str
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    stage_name str
    Name of the Stage that will be exported.
    parameters Mapping[str, str]
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.
    restApiId String
    Identifier of the associated REST API.
    sdkType String
    Language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    stageName String
    Name of the Stage that will be exported.
    parameters Map<String>
    Key-value map of query string parameters sdk_type properties of the SDK. For SDK Type of objectivec or swift, a parameter named classPrefix is required. For SDK Type of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For SDK Type of java, parameters named serviceName and javaPackageName are required.

    getSdk Result

    The following output properties are available:

    Body string
    SDK as a string.
    ContentDisposition string
    Content-disposition header value in the HTTP response.
    ContentType string
    Content-type header value in the HTTP response.
    Id string
    The provider-assigned unique ID for this managed resource.
    RestApiId string
    SdkType string
    StageName string
    Parameters Dictionary<string, string>
    Body string
    SDK as a string.
    ContentDisposition string
    Content-disposition header value in the HTTP response.
    ContentType string
    Content-type header value in the HTTP response.
    Id string
    The provider-assigned unique ID for this managed resource.
    RestApiId string
    SdkType string
    StageName string
    Parameters map[string]string
    body String
    SDK as a string.
    contentDisposition String
    Content-disposition header value in the HTTP response.
    contentType String
    Content-type header value in the HTTP response.
    id String
    The provider-assigned unique ID for this managed resource.
    restApiId String
    sdkType String
    stageName String
    parameters Map<String,String>
    body string
    SDK as a string.
    contentDisposition string
    Content-disposition header value in the HTTP response.
    contentType string
    Content-type header value in the HTTP response.
    id string
    The provider-assigned unique ID for this managed resource.
    restApiId string
    sdkType string
    stageName string
    parameters {[key: string]: string}
    body str
    SDK as a string.
    content_disposition str
    Content-disposition header value in the HTTP response.
    content_type str
    Content-type header value in the HTTP response.
    id str
    The provider-assigned unique ID for this managed resource.
    rest_api_id str
    sdk_type str
    stage_name str
    parameters Mapping[str, str]
    body String
    SDK as a string.
    contentDisposition String
    Content-disposition header value in the HTTP response.
    contentType String
    Content-type header value in the HTTP response.
    id String
    The provider-assigned unique ID for this managed resource.
    restApiId String
    sdkType String
    stageName String
    parameters Map<String>

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws