com.pulumi.aws.apigateway.ApiKeyArgs 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.apigateway;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ApiKeyArgs extends com.pulumi.resources.ResourceArgs {
public static final ApiKeyArgs Empty = new ApiKeyArgs();
/**
* An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*
*/
@Import(name="customerId")
private @Nullable Output customerId;
/**
* @return An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*
*/
public Optional> customerId() {
return Optional.ofNullable(this.customerId);
}
/**
* API key description. Defaults to "Managed by Pulumi".
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return API key description. Defaults to "Managed by Pulumi".
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* Whether the API key can be used by callers. Defaults to `true`.
*
*/
@Import(name="enabled")
private @Nullable Output enabled;
/**
* @return Whether the API key can be used by callers. Defaults to `true`.
*
*/
public Optional> enabled() {
return Optional.ofNullable(this.enabled);
}
/**
* Name of the API key.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Name of the API key.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*
*/
@Import(name="value")
private @Nullable Output value;
/**
* @return Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*
*/
public Optional> value() {
return Optional.ofNullable(this.value);
}
private ApiKeyArgs() {}
private ApiKeyArgs(ApiKeyArgs $) {
this.customerId = $.customerId;
this.description = $.description;
this.enabled = $.enabled;
this.name = $.name;
this.tags = $.tags;
this.value = $.value;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ApiKeyArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ApiKeyArgs $;
public Builder() {
$ = new ApiKeyArgs();
}
public Builder(ApiKeyArgs defaults) {
$ = new ApiKeyArgs(Objects.requireNonNull(defaults));
}
/**
* @param customerId An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*
* @return builder
*
*/
public Builder customerId(@Nullable Output customerId) {
$.customerId = customerId;
return this;
}
/**
* @param customerId An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*
* @return builder
*
*/
public Builder customerId(String customerId) {
return customerId(Output.of(customerId));
}
/**
* @param description API key description. Defaults to "Managed by Pulumi".
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description API key description. Defaults to "Managed by Pulumi".
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param enabled Whether the API key can be used by callers. Defaults to `true`.
*
* @return builder
*
*/
public Builder enabled(@Nullable Output enabled) {
$.enabled = enabled;
return this;
}
/**
* @param enabled Whether the API key can be used by callers. Defaults to `true`.
*
* @return builder
*
*/
public Builder enabled(Boolean enabled) {
return enabled(Output.of(enabled));
}
/**
* @param name Name of the API key.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Name of the API key.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param value Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*
* @return builder
*
*/
public Builder value(@Nullable Output value) {
$.value = value;
return this;
}
/**
* @param value Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*
* @return builder
*
*/
public Builder value(String value) {
return value(Output.of(value));
}
public ApiKeyArgs build() {
$.description = Codegen.stringProp("description").output().arg($.description).def("Managed by Pulumi").getNullable();
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy