com.pulumi.aws.elasticbeanstalk.EnvironmentArgs 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.elasticbeanstalk;
import com.pulumi.aws.elasticbeanstalk.inputs.EnvironmentSettingArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class EnvironmentArgs extends com.pulumi.resources.ResourceArgs {
public static final EnvironmentArgs Empty = new EnvironmentArgs();
/**
* Name of the application that contains the version
* to be deployed
*
*/
@Import(name="application", required=true)
private Output application;
/**
* @return Name of the application that contains the version
* to be deployed
*
*/
public Output application() {
return this.application;
}
/**
* Prefix to use for the fully qualified DNS name of
* the Environment.
*
*/
@Import(name="cnamePrefix")
private @Nullable Output cnamePrefix;
/**
* @return Prefix to use for the fully qualified DNS name of
* the Environment.
*
*/
public Optional> cnamePrefix() {
return Optional.ofNullable(this.cnamePrefix);
}
/**
* Short description of the Environment
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return Short description of the Environment
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* A unique name for this Environment. This name is used
* in the application URL
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return A unique name for this Environment. This name is used
* in the application URL
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Elastic Beanstalk [Platform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn)
* to use in deployment
*
*/
@Import(name="platformArn")
private @Nullable Output platformArn;
/**
* @return The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Elastic Beanstalk [Platform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn)
* to use in deployment
*
*/
public Optional> platformArn() {
return Optional.ofNullable(this.platformArn);
}
/**
* The time between polling the AWS API to
* check if changes have been applied. Use this to adjust the rate of API calls
* for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to
* use the default behavior, which is an exponential backoff
*
*/
@Import(name="pollInterval")
private @Nullable Output pollInterval;
/**
* @return The time between polling the AWS API to
* check if changes have been applied. Use this to adjust the rate of API calls
* for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to
* use the default behavior, which is an exponential backoff
*
*/
public Optional> pollInterval() {
return Optional.ofNullable(this.pollInterval);
}
/**
* Option settings to configure the new Environment. These
* override specific values that are set as defaults. The format is detailed
* below in Option Settings
*
*/
@Import(name="settings")
private @Nullable Output> settings;
/**
* @return Option settings to configure the new Environment. These
* override specific values that are set as defaults. The format is detailed
* below in Option Settings
*
*/
public Optional>> settings() {
return Optional.ofNullable(this.settings);
}
/**
* A solution stack to base your environment
* off of. Example stacks can be found in the [Amazon API documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html)
*
*/
@Import(name="solutionStackName")
private @Nullable Output solutionStackName;
/**
* @return A solution stack to base your environment
* off of. Example stacks can be found in the [Amazon API documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html)
*
*/
public Optional> solutionStackName() {
return Optional.ofNullable(this.solutionStackName);
}
/**
* A set of tags to apply to the Environment. 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 A set of tags to apply to the Environment. 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);
}
/**
* The name of the Elastic Beanstalk Configuration
* template to use in deployment
*
*/
@Import(name="templateName")
private @Nullable Output templateName;
/**
* @return The name of the Elastic Beanstalk Configuration
* template to use in deployment
*
*/
public Optional> templateName() {
return Optional.ofNullable(this.templateName);
}
/**
* Elastic Beanstalk Environment tier. Valid values are `Worker`
* or `WebServer`. If tier is left blank `WebServer` will be used.
*
*/
@Import(name="tier")
private @Nullable Output tier;
/**
* @return Elastic Beanstalk Environment tier. Valid values are `Worker`
* or `WebServer`. If tier is left blank `WebServer` will be used.
*
*/
public Optional> tier() {
return Optional.ofNullable(this.tier);
}
/**
* The name of the Elastic Beanstalk Application Version
* to use in deployment.
*
*/
@Import(name="version")
private @Nullable Output version;
/**
* @return The name of the Elastic Beanstalk Application Version
* to use in deployment.
*
*/
public Optional> version() {
return Optional.ofNullable(this.version);
}
/**
* The maximum
* [duration](https://golang.org/pkg/time/#ParseDuration) that this provider should
* wait for an Elastic Beanstalk Environment to be in a ready state before timing
* out.
*
*/
@Import(name="waitForReadyTimeout")
private @Nullable Output waitForReadyTimeout;
/**
* @return The maximum
* [duration](https://golang.org/pkg/time/#ParseDuration) that this provider should
* wait for an Elastic Beanstalk Environment to be in a ready state before timing
* out.
*
*/
public Optional> waitForReadyTimeout() {
return Optional.ofNullable(this.waitForReadyTimeout);
}
private EnvironmentArgs() {}
private EnvironmentArgs(EnvironmentArgs $) {
this.application = $.application;
this.cnamePrefix = $.cnamePrefix;
this.description = $.description;
this.name = $.name;
this.platformArn = $.platformArn;
this.pollInterval = $.pollInterval;
this.settings = $.settings;
this.solutionStackName = $.solutionStackName;
this.tags = $.tags;
this.templateName = $.templateName;
this.tier = $.tier;
this.version = $.version;
this.waitForReadyTimeout = $.waitForReadyTimeout;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(EnvironmentArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private EnvironmentArgs $;
public Builder() {
$ = new EnvironmentArgs();
}
public Builder(EnvironmentArgs defaults) {
$ = new EnvironmentArgs(Objects.requireNonNull(defaults));
}
/**
* @param application Name of the application that contains the version
* to be deployed
*
* @return builder
*
*/
public Builder application(Output application) {
$.application = application;
return this;
}
/**
* @param application Name of the application that contains the version
* to be deployed
*
* @return builder
*
*/
public Builder application(String application) {
return application(Output.of(application));
}
/**
* @param cnamePrefix Prefix to use for the fully qualified DNS name of
* the Environment.
*
* @return builder
*
*/
public Builder cnamePrefix(@Nullable Output cnamePrefix) {
$.cnamePrefix = cnamePrefix;
return this;
}
/**
* @param cnamePrefix Prefix to use for the fully qualified DNS name of
* the Environment.
*
* @return builder
*
*/
public Builder cnamePrefix(String cnamePrefix) {
return cnamePrefix(Output.of(cnamePrefix));
}
/**
* @param description Short description of the Environment
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description Short description of the Environment
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param name A unique name for this Environment. This name is used
* in the application URL
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name A unique name for this Environment. This name is used
* in the application URL
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param platformArn The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Elastic Beanstalk [Platform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn)
* to use in deployment
*
* @return builder
*
*/
public Builder platformArn(@Nullable Output platformArn) {
$.platformArn = platformArn;
return this;
}
/**
* @param platformArn The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Elastic Beanstalk [Platform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn)
* to use in deployment
*
* @return builder
*
*/
public Builder platformArn(String platformArn) {
return platformArn(Output.of(platformArn));
}
/**
* @param pollInterval The time between polling the AWS API to
* check if changes have been applied. Use this to adjust the rate of API calls
* for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to
* use the default behavior, which is an exponential backoff
*
* @return builder
*
*/
public Builder pollInterval(@Nullable Output pollInterval) {
$.pollInterval = pollInterval;
return this;
}
/**
* @param pollInterval The time between polling the AWS API to
* check if changes have been applied. Use this to adjust the rate of API calls
* for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to
* use the default behavior, which is an exponential backoff
*
* @return builder
*
*/
public Builder pollInterval(String pollInterval) {
return pollInterval(Output.of(pollInterval));
}
/**
* @param settings Option settings to configure the new Environment. These
* override specific values that are set as defaults. The format is detailed
* below in Option Settings
*
* @return builder
*
*/
public Builder settings(@Nullable Output> settings) {
$.settings = settings;
return this;
}
/**
* @param settings Option settings to configure the new Environment. These
* override specific values that are set as defaults. The format is detailed
* below in Option Settings
*
* @return builder
*
*/
public Builder settings(List settings) {
return settings(Output.of(settings));
}
/**
* @param settings Option settings to configure the new Environment. These
* override specific values that are set as defaults. The format is detailed
* below in Option Settings
*
* @return builder
*
*/
public Builder settings(EnvironmentSettingArgs... settings) {
return settings(List.of(settings));
}
/**
* @param solutionStackName A solution stack to base your environment
* off of. Example stacks can be found in the [Amazon API documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html)
*
* @return builder
*
*/
public Builder solutionStackName(@Nullable Output solutionStackName) {
$.solutionStackName = solutionStackName;
return this;
}
/**
* @param solutionStackName A solution stack to base your environment
* off of. Example stacks can be found in the [Amazon API documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html)
*
* @return builder
*
*/
public Builder solutionStackName(String solutionStackName) {
return solutionStackName(Output.of(solutionStackName));
}
/**
* @param tags A set of tags to apply to the Environment. 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 A set of tags to apply to the Environment. 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 templateName The name of the Elastic Beanstalk Configuration
* template to use in deployment
*
* @return builder
*
*/
public Builder templateName(@Nullable Output templateName) {
$.templateName = templateName;
return this;
}
/**
* @param templateName The name of the Elastic Beanstalk Configuration
* template to use in deployment
*
* @return builder
*
*/
public Builder templateName(String templateName) {
return templateName(Output.of(templateName));
}
/**
* @param tier Elastic Beanstalk Environment tier. Valid values are `Worker`
* or `WebServer`. If tier is left blank `WebServer` will be used.
*
* @return builder
*
*/
public Builder tier(@Nullable Output tier) {
$.tier = tier;
return this;
}
/**
* @param tier Elastic Beanstalk Environment tier. Valid values are `Worker`
* or `WebServer`. If tier is left blank `WebServer` will be used.
*
* @return builder
*
*/
public Builder tier(String tier) {
return tier(Output.of(tier));
}
/**
* @param version The name of the Elastic Beanstalk Application Version
* to use in deployment.
*
* @return builder
*
*/
public Builder version(@Nullable Output version) {
$.version = version;
return this;
}
/**
* @param version The name of the Elastic Beanstalk Application Version
* to use in deployment.
*
* @return builder
*
*/
public Builder version(String version) {
return version(Output.of(version));
}
/**
* @param waitForReadyTimeout The maximum
* [duration](https://golang.org/pkg/time/#ParseDuration) that this provider should
* wait for an Elastic Beanstalk Environment to be in a ready state before timing
* out.
*
* @return builder
*
*/
public Builder waitForReadyTimeout(@Nullable Output waitForReadyTimeout) {
$.waitForReadyTimeout = waitForReadyTimeout;
return this;
}
/**
* @param waitForReadyTimeout The maximum
* [duration](https://golang.org/pkg/time/#ParseDuration) that this provider should
* wait for an Elastic Beanstalk Environment to be in a ready state before timing
* out.
*
* @return builder
*
*/
public Builder waitForReadyTimeout(String waitForReadyTimeout) {
return waitForReadyTimeout(Output.of(waitForReadyTimeout));
}
public EnvironmentArgs build() {
if ($.application == null) {
throw new MissingRequiredPropertyException("EnvironmentArgs", "application");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy