Skip to content

ConfigurationSettingsDescription

Source code in docs_src/capo_elastic_beanstalk/types/configuration_settings_description.py
class ConfigurationSettingsDescription(TypedDict, closed=True):
    solution_stack_name: NotRequired[
        "capo_elastic_beanstalk.types.solution_stack_name.SolutionStackName"
    ]
    """<p>The name of the solution stack this configuration set uses.</p>"""
    platform_arn: NotRequired["capo_elastic_beanstalk.types.platform_arn.PlatformArn"]
    """<p>The ARN of the platform version.</p>"""
    application_name: NotRequired[
        "capo_elastic_beanstalk.types.application_name.ApplicationName"
    ]
    """<p>The name of the application associated with this configuration set.</p>"""
    template_name: NotRequired[
        "capo_elastic_beanstalk.types.configuration_template_name.ConfigurationTemplateName"
    ]
    """<p> If not <code>null</code>, the name of the configuration template for this configuration set. </p>"""
    description: NotRequired["capo_elastic_beanstalk.types.description.Description"]
    """<p>Describes this configuration set.</p>"""
    environment_name: NotRequired[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ]
    """<p> If not <code>null</code>, the name of the environment for this configuration set. </p>"""
    deployment_status: NotRequired[
        "capo_elastic_beanstalk.types.configuration_deployment_status.ConfigurationDeploymentStatus"
    ]
    """<p> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </p> <ul> <li> <p> <code>null</code>: This configuration is not associated with a running environment.</p> </li> <li> <p> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.</p> </li> <li> <p> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment.</p> </li> <li> <p> <code>failed</code>: This is a draft configuration that failed to successfully deploy.</p> </li> </ul>"""
    date_created: NotRequired["capo_elastic_beanstalk.types.creation_date.CreationDate"]
    """<p>The date (in UTC time) when this configuration set was created.</p>"""
    date_updated: NotRequired["capo_elastic_beanstalk.types.update_date.UpdateDate"]
    """<p>The date (in UTC time) when this configuration set was last modified.</p>"""
    option_settings: NotRequired[
        "capo_elastic_beanstalk.types.configuration_option_settings_list.ConfigurationOptionSettingsList"
    ]
    """<p>A list of the configuration options and their values in this configuration set.</p>"""

application_name instance-attribute

application_name: NotRequired[ApplicationName]

The name of the application associated with this configuration set.

date_created instance-attribute

date_created: NotRequired[CreationDate]

The date (in UTC time) when this configuration set was created.

date_updated instance-attribute

date_updated: NotRequired[UpdateDate]

The date (in UTC time) when this configuration set was last modified.

deployment_status instance-attribute

deployment_status: NotRequired[ConfigurationDeploymentStatus]

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

  • null: This configuration is not associated with a running environment.

  • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

  • deployed: This is the configuration that is currently deployed to the associated running environment.

  • failed: This is a draft configuration that failed to successfully deploy.

description instance-attribute

description: NotRequired[Description]

Describes this configuration set.

environment_name instance-attribute

environment_name: NotRequired[EnvironmentName]

If not null, the name of the environment for this configuration set.

option_settings instance-attribute

option_settings: NotRequired[ConfigurationOptionSettingsList]

A list of the configuration options and their values in this configuration set.

platform_arn instance-attribute

platform_arn: NotRequired[PlatformArn]

The ARN of the platform version.

solution_stack_name instance-attribute

solution_stack_name: NotRequired[SolutionStackName]

The name of the solution stack this configuration set uses.

template_name instance-attribute

template_name: NotRequired[ConfigurationTemplateName]

If not null, the name of the configuration template for this configuration set.