com.pulumi.aws.apigatewayv2.inputs.GetExportArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.apigatewayv2.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class GetExportArgs extends com.pulumi.resources.InvokeArgs {
public static final GetExportArgs Empty = new GetExportArgs();
/**
* API identifier.
*
*/
@Import(name="apiId", required=true)
private Output apiId;
/**
* @return API identifier.
*
*/
public Output apiId() {
return this.apiId;
}
/**
* Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is `1.0`.
*
*/
@Import(name="exportVersion")
private @Nullable Output exportVersion;
/**
* @return Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is `1.0`.
*
*/
public Optional> exportVersion() {
return Optional.ofNullable(this.exportVersion);
}
/**
* Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
*
*/
@Import(name="includeExtensions")
private @Nullable Output includeExtensions;
/**
* @return Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
*
*/
public Optional> includeExtensions() {
return Optional.ofNullable(this.includeExtensions);
}
/**
* Output type of the exported definition file. Valid values are `JSON` and `YAML`.
*
*/
@Import(name="outputType", required=true)
private Output outputType;
/**
* @return Output type of the exported definition file. Valid values are `JSON` and `YAML`.
*
*/
public Output outputType() {
return this.outputType;
}
/**
* Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value.
*
*/
@Import(name="specification", required=true)
private Output specification;
/**
* @return Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value.
*
*/
public Output specification() {
return this.specification;
}
/**
* Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
*
*/
@Import(name="stageName")
private @Nullable Output stageName;
/**
* @return Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
*
*/
public Optional> stageName() {
return Optional.ofNullable(this.stageName);
}
private GetExportArgs() {}
private GetExportArgs(GetExportArgs $) {
this.apiId = $.apiId;
this.exportVersion = $.exportVersion;
this.includeExtensions = $.includeExtensions;
this.outputType = $.outputType;
this.specification = $.specification;
this.stageName = $.stageName;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetExportArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private GetExportArgs $;
public Builder() {
$ = new GetExportArgs();
}
public Builder(GetExportArgs defaults) {
$ = new GetExportArgs(Objects.requireNonNull(defaults));
}
/**
* @param apiId API identifier.
*
* @return builder
*
*/
public Builder apiId(Output apiId) {
$.apiId = apiId;
return this;
}
/**
* @param apiId API identifier.
*
* @return builder
*
*/
public Builder apiId(String apiId) {
return apiId(Output.of(apiId));
}
/**
* @param exportVersion Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is `1.0`.
*
* @return builder
*
*/
public Builder exportVersion(@Nullable Output exportVersion) {
$.exportVersion = exportVersion;
return this;
}
/**
* @param exportVersion Version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is `1.0`.
*
* @return builder
*
*/
public Builder exportVersion(String exportVersion) {
return exportVersion(Output.of(exportVersion));
}
/**
* @param includeExtensions Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
*
* @return builder
*
*/
public Builder includeExtensions(@Nullable Output includeExtensions) {
$.includeExtensions = includeExtensions;
return this;
}
/**
* @param includeExtensions Whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
*
* @return builder
*
*/
public Builder includeExtensions(Boolean includeExtensions) {
return includeExtensions(Output.of(includeExtensions));
}
/**
* @param outputType Output type of the exported definition file. Valid values are `JSON` and `YAML`.
*
* @return builder
*
*/
public Builder outputType(Output outputType) {
$.outputType = outputType;
return this;
}
/**
* @param outputType Output type of the exported definition file. Valid values are `JSON` and `YAML`.
*
* @return builder
*
*/
public Builder outputType(String outputType) {
return outputType(Output.of(outputType));
}
/**
* @param specification Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value.
*
* @return builder
*
*/
public Builder specification(Output specification) {
$.specification = specification;
return this;
}
/**
* @param specification Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value.
*
* @return builder
*
*/
public Builder specification(String specification) {
return specification(Output.of(specification));
}
/**
* @param stageName Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
*
* @return builder
*
*/
public Builder stageName(@Nullable Output stageName) {
$.stageName = stageName;
return this;
}
/**
* @param stageName Name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
*
* @return builder
*
*/
public Builder stageName(String stageName) {
return stageName(Output.of(stageName));
}
public GetExportArgs build() {
if ($.apiId == null) {
throw new MissingRequiredPropertyException("GetExportArgs", "apiId");
}
if ($.outputType == null) {
throw new MissingRequiredPropertyException("GetExportArgs", "outputType");
}
if ($.specification == null) {
throw new MissingRequiredPropertyException("GetExportArgs", "specification");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy