UpdateEnvironmentMessage

public struct UpdateEnvironmentMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The name of the application with which the environment is associated.

    Declaration

    Swift

    public let applicationName: String?

  • If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

    Declaration

    Swift

    public let description: String?

  • The ID of the environment to update. If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    Declaration

    Swift

    public let environmentId: String?

  • The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    Declaration

    Swift

    public let environmentName: String?

  • The name of the group to which the target environment belongs. Specify a group name only if the environment’s name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

    Declaration

    Swift

    public let groupName: String?

  • If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

    Declaration

    Swift

    public let optionSettings: [ConfigurationOptionSetting]?

  • A list of custom user-defined configuration options to remove from the configuration set for this environment.

    Declaration

    Swift

    public let optionsToRemove: [OptionSpecification]?

  • The ARN of the platform, if used.

    Declaration

    Swift

    public let platformArn: String?

  • This specifies the platform version that the environment will run after the environment is updated.

    Declaration

    Swift

    public let solutionStackName: String?

  • If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

    Declaration

    Swift

    public let templateName: String?

  • This specifies the tier to use to update the environment. Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

    Declaration

    Swift

    public let tier: EnvironmentTier?

  • If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

    Declaration

    Swift

    public let versionLabel: String?

  • Undocumented

    Declaration

    Swift

    public init(applicationName: String? = nil, description: String? = nil, environmentId: String? = nil, environmentName: String? = nil, groupName: String? = nil, optionSettings: [ConfigurationOptionSetting]? = nil, optionsToRemove: [OptionSpecification]? = nil, platformArn: String? = nil, solutionStackName: String? = nil, templateName: String? = nil, tier: EnvironmentTier? = nil, versionLabel: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws