1. Packages
  2. AWS Native
  3. API Docs
  4. elasticbeanstalk
  5. Environment

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.elasticbeanstalk.Environment

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    Resource Type definition for AWS::ElasticBeanstalk::Environment

    Create Environment Resource

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def Environment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    application_name: Optional[str] = None,
                    cname_prefix: Optional[str] = None,
                    description: Optional[str] = None,
                    environment_name: Optional[str] = None,
                    operations_role: Optional[str] = None,
                    option_settings: Optional[Sequence[EnvironmentOptionSettingArgs]] = None,
                    platform_arn: Optional[str] = None,
                    solution_stack_name: Optional[str] = None,
                    tags: Optional[Sequence[EnvironmentTagArgs]] = None,
                    template_name: Optional[str] = None,
                    tier: Optional[EnvironmentTierArgs] = None,
                    version_label: Optional[str] = None)
    @overload
    def Environment(resource_name: str,
                    args: EnvironmentArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
    public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
    
    type: aws-native:elasticbeanstalk:Environment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args EnvironmentArgs
    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 EnvironmentArgs
    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 EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApplicationName string

    The name of the application that is associated with this environment.

    CnamePrefix string

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    Description string

    Your description for this environment.

    EnvironmentName string

    A unique name for the environment.

    OperationsRole string

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    OptionSettings List<Pulumi.AwsNative.ElasticBeanstalk.Inputs.EnvironmentOptionSetting>

    Key-value pairs defining configuration options for this environment, such as the instance type.

    PlatformArn string

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    SolutionStackName string

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    Tags List<Pulumi.AwsNative.ElasticBeanstalk.Inputs.EnvironmentTag>

    Specifies the tags applied to resources in the environment.

    TemplateName string

    The name of the Elastic Beanstalk configuration template to use with the environment.

    Tier Pulumi.AwsNative.ElasticBeanstalk.Inputs.EnvironmentTier

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    VersionLabel string

    The name of the application version to deploy.

    ApplicationName string

    The name of the application that is associated with this environment.

    CnamePrefix string

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    Description string

    Your description for this environment.

    EnvironmentName string

    A unique name for the environment.

    OperationsRole string

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    OptionSettings []EnvironmentOptionSettingArgs

    Key-value pairs defining configuration options for this environment, such as the instance type.

    PlatformArn string

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    SolutionStackName string

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    Tags []EnvironmentTagArgs

    Specifies the tags applied to resources in the environment.

    TemplateName string

    The name of the Elastic Beanstalk configuration template to use with the environment.

    Tier EnvironmentTierArgs

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    VersionLabel string

    The name of the application version to deploy.

    applicationName String

    The name of the application that is associated with this environment.

    cnamePrefix String

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    description String

    Your description for this environment.

    environmentName String

    A unique name for the environment.

    operationsRole String

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    optionSettings List<EnvironmentOptionSetting>

    Key-value pairs defining configuration options for this environment, such as the instance type.

    platformArn String

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    solutionStackName String

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    tags List<EnvironmentTag>

    Specifies the tags applied to resources in the environment.

    templateName String

    The name of the Elastic Beanstalk configuration template to use with the environment.

    tier EnvironmentTier

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    versionLabel String

    The name of the application version to deploy.

    applicationName string

    The name of the application that is associated with this environment.

    cnamePrefix string

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    description string

    Your description for this environment.

    environmentName string

    A unique name for the environment.

    operationsRole string

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    optionSettings EnvironmentOptionSetting[]

    Key-value pairs defining configuration options for this environment, such as the instance type.

    platformArn string

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    solutionStackName string

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    tags EnvironmentTag[]

    Specifies the tags applied to resources in the environment.

    templateName string

    The name of the Elastic Beanstalk configuration template to use with the environment.

    tier EnvironmentTier

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    versionLabel string

    The name of the application version to deploy.

    application_name str

    The name of the application that is associated with this environment.

    cname_prefix str

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    description str

    Your description for this environment.

    environment_name str

    A unique name for the environment.

    operations_role str

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    option_settings Sequence[EnvironmentOptionSettingArgs]

    Key-value pairs defining configuration options for this environment, such as the instance type.

    platform_arn str

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    solution_stack_name str

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    tags Sequence[EnvironmentTagArgs]

    Specifies the tags applied to resources in the environment.

    template_name str

    The name of the Elastic Beanstalk configuration template to use with the environment.

    tier EnvironmentTierArgs

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    version_label str

    The name of the application version to deploy.

    applicationName String

    The name of the application that is associated with this environment.

    cnamePrefix String

    If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    description String

    Your description for this environment.

    environmentName String

    A unique name for the environment.

    operationsRole String

    The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

    optionSettings List<Property Map>

    Key-value pairs defining configuration options for this environment, such as the instance type.

    platformArn String

    The Amazon Resource Name (ARN) of the custom platform to use with the environment.

    solutionStackName String

    The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.

    tags List<Property Map>

    Specifies the tags applied to resources in the environment.

    templateName String

    The name of the Elastic Beanstalk configuration template to use with the environment.

    tier Property Map

    Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

    versionLabel String

    The name of the application version to deploy.

    Outputs

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

    EndpointUrl string
    Id string

    The provider-assigned unique ID for this managed resource.

    EndpointUrl string
    Id string

    The provider-assigned unique ID for this managed resource.

    endpointUrl String
    id String

    The provider-assigned unique ID for this managed resource.

    endpointUrl string
    id string

    The provider-assigned unique ID for this managed resource.

    endpoint_url str
    id str

    The provider-assigned unique ID for this managed resource.

    endpointUrl String
    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    EnvironmentOptionSetting, EnvironmentOptionSettingArgs

    Namespace string

    A unique namespace that identifies the option's associated AWS resource.

    OptionName string

    The name of the configuration option.

    ResourceName string

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    Value string

    The current value for the configuration option.

    Namespace string

    A unique namespace that identifies the option's associated AWS resource.

    OptionName string

    The name of the configuration option.

    ResourceName string

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    Value string

    The current value for the configuration option.

    namespace String

    A unique namespace that identifies the option's associated AWS resource.

    optionName String

    The name of the configuration option.

    resourceName String

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    value String

    The current value for the configuration option.

    namespace string

    A unique namespace that identifies the option's associated AWS resource.

    optionName string

    The name of the configuration option.

    resourceName string

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    value string

    The current value for the configuration option.

    namespace str

    A unique namespace that identifies the option's associated AWS resource.

    option_name str

    The name of the configuration option.

    resource_name str

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    value str

    The current value for the configuration option.

    namespace String

    A unique namespace that identifies the option's associated AWS resource.

    optionName String

    The name of the configuration option.

    resourceName String

    A unique resource name for the option setting. Use it for a time–based scaling configuration option.

    value String

    The current value for the configuration option.

    EnvironmentTag, EnvironmentTagArgs

    Key string

    The key name of the tag.

    Value string

    The value for the tag.

    Key string

    The key name of the tag.

    Value string

    The value for the tag.

    key String

    The key name of the tag.

    value String

    The value for the tag.

    key string

    The key name of the tag.

    value string

    The value for the tag.

    key str

    The key name of the tag.

    value str

    The value for the tag.

    key String

    The key name of the tag.

    value String

    The value for the tag.

    EnvironmentTier, EnvironmentTierArgs

    Name string

    The name of this environment tier.

    Type string

    The type of this environment tier.

    Version string

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    Name string

    The name of this environment tier.

    Type string

    The type of this environment tier.

    Version string

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    name String

    The name of this environment tier.

    type String

    The type of this environment tier.

    version String

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    name string

    The name of this environment tier.

    type string

    The type of this environment tier.

    version string

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    name str

    The name of this environment tier.

    type str

    The type of this environment tier.

    version str

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    name String

    The name of this environment tier.

    type String

    The type of this environment tier.

    version String

    The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi