package types

import "github.com/aws/aws-sdk-go-v2/service/appconfig/types"

Index

Types

type Application

type Application struct {

	// The description of the application.
	Description *string

	// The application ID.
	Id *string

	// The application name.
	Name *string
}

type BadRequestException

type BadRequestException struct {
	Message *string
}

The input fails to satisfy the constraints specified by an AWS service.

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type BytesMeasure

type BytesMeasure string
const (
	BytesMeasureKilobytes BytesMeasure = "KILOBYTES"
)

Enum values for BytesMeasure

type ConfigurationProfileSummary

type ConfigurationProfileSummary struct {

	// The application ID.
	ApplicationId *string

	// The ID of the configuration profile.
	Id *string

	// The URI location of the configuration.
	LocationUri *string

	// The name of the configuration profile.
	Name *string

	// The types of validators in the configuration profile.
	ValidatorTypes []ValidatorType
}

A summary of a configuration profile.

type ConflictException

type ConflictException struct {
	Message *string
}

The request could not be processed because of conflict in the current state of the resource.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type DeploymentEvent

type DeploymentEvent struct {

	// A description of the deployment event. Descriptions include, but are not limited
	// to, the user account or the CloudWatch alarm ARN that initiated a rollback, the
	// percentage of hosts that received the deployment, or in the case of an internal
	// error, a recommendation to attempt a new deployment.
	Description *string

	// The type of deployment event. Deployment event types include the start, stop, or
	// completion of a deployment; a percentage update; the start or stop of a bake
	// period; the start or completion of a rollback.
	EventType DeploymentEventType

	// The date and time the event occurred.
	OccurredAt *time.Time

	// The entity that triggered the deployment event. Events can be triggered by a
	// user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.
	TriggeredBy TriggeredBy
}

An object that describes a deployment event.

type DeploymentEventType

type DeploymentEventType string
const (
	DeploymentEventTypePercentage_updated   DeploymentEventType = "PERCENTAGE_UPDATED"
	DeploymentEventTypeRollback_started     DeploymentEventType = "ROLLBACK_STARTED"
	DeploymentEventTypeRollback_completed   DeploymentEventType = "ROLLBACK_COMPLETED"
	DeploymentEventTypeBake_time_started    DeploymentEventType = "BAKE_TIME_STARTED"
	DeploymentEventTypeDeployment_started   DeploymentEventType = "DEPLOYMENT_STARTED"
	DeploymentEventTypeDeployment_completed DeploymentEventType = "DEPLOYMENT_COMPLETED"
)

Enum values for DeploymentEventType

type DeploymentState

type DeploymentState string
const (
	DeploymentStateBaking       DeploymentState = "BAKING"
	DeploymentStateValidating   DeploymentState = "VALIDATING"
	DeploymentStateDeploying    DeploymentState = "DEPLOYING"
	DeploymentStateComplete     DeploymentState = "COMPLETE"
	DeploymentStateRolling_back DeploymentState = "ROLLING_BACK"
	DeploymentStateRolled_back  DeploymentState = "ROLLED_BACK"
)

Enum values for DeploymentState

type DeploymentStrategy

type DeploymentStrategy struct {

	// Total amount of time the deployment lasted.
	DeploymentDurationInMinutes *int32

	// The description of the deployment strategy.
	Description *string

	// The amount of time AppConfig monitored for alarms before considering the
	// deployment to be complete and no longer eligible for automatic roll back.
	FinalBakeTimeInMinutes *int32

	// The percentage of targets that received a deployed configuration during each
	// interval.
	GrowthFactor *float32

	// The algorithm used to define how percentage grew over time.
	GrowthType GrowthType

	// The deployment strategy ID.
	Id *string

	// The name of the deployment strategy.
	Name *string

	// Save the deployment strategy to a Systems Manager (SSM) document.
	ReplicateTo ReplicateTo
}

type DeploymentSummary

type DeploymentSummary struct {

	// Time the deployment completed.
	CompletedAt *time.Time

	// The name of the configuration.
	ConfigurationName *string

	// The version of the configuration.
	ConfigurationVersion *string

	// Total amount of time the deployment lasted.
	DeploymentDurationInMinutes *int32

	// The sequence number of the deployment.
	DeploymentNumber *int32

	// The amount of time AppConfig monitors for alarms before considering the
	// deployment to be complete and no longer eligible for automatic roll back.
	FinalBakeTimeInMinutes *int32

	// The percentage of targets to receive a deployed configuration during each
	// interval.
	GrowthFactor *float32

	// The algorithm used to define how percentage grows over time.
	GrowthType GrowthType

	// The percentage of targets for which the deployment is available.
	PercentageComplete *float32

	// Time the deployment started.
	StartedAt *time.Time

	// The state of the deployment.
	State DeploymentState
}

Information about the deployment.

type Environment

type Environment struct {

	// The application ID.
	ApplicationId *string

	// The description of the environment.
	Description *string

	// The environment ID.
	Id *string

	// Amazon CloudWatch alarms monitored during the deployment.
	Monitors []*Monitor

	// The name of the environment.
	Name *string

	// The state of the environment. An environment can be in one of the following
	// states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
	State EnvironmentState
}

type EnvironmentState

type EnvironmentState string
const (
	EnvironmentStateReady_for_deployment EnvironmentState = "READY_FOR_DEPLOYMENT"
	EnvironmentStateDeploying            EnvironmentState = "DEPLOYING"
	EnvironmentStateRolling_back         EnvironmentState = "ROLLING_BACK"
	EnvironmentStateRolled_back          EnvironmentState = "ROLLED_BACK"
)

Enum values for EnvironmentState

type GrowthType

type GrowthType string
const (
	GrowthTypeLinear      GrowthType = "LINEAR"
	GrowthTypeExponential GrowthType = "EXPONENTIAL"
)

Enum values for GrowthType

type HostedConfigurationVersionSummary

type HostedConfigurationVersionSummary struct {

	// The application ID.
	ApplicationId *string

	// The configuration profile ID.
	ConfigurationProfileId *string

	// A standard MIME type describing the format of the configuration content. For
	// more information, see Content-Type
	// (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).
	ContentType *string

	// A description of the configuration.
	Description *string

	// The configuration version.
	VersionNumber *int32
}

Information about the configuration.

type InternalServerException

type InternalServerException struct {
	Message *string
}

There was an internal failure in the AppConfig service.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type Monitor

type Monitor struct {

	// ARN of the Amazon CloudWatch alarm.
	AlarmArn *string

	// ARN of an IAM role for AppConfig to monitor AlarmArn.
	AlarmRoleArn *string
}

Amazon CloudWatch alarms to monitor during the deployment process.

type PayloadTooLargeException

type PayloadTooLargeException struct {
	Message *string

	Limit   *float32
	Size    *float32
	Measure BytesMeasure
}

The configuration size is too large.

func (*PayloadTooLargeException) Error

func (e *PayloadTooLargeException) Error() string

func (*PayloadTooLargeException) ErrorCode

func (e *PayloadTooLargeException) ErrorCode() string

func (*PayloadTooLargeException) ErrorFault

func (e *PayloadTooLargeException) ErrorFault() smithy.ErrorFault

func (*PayloadTooLargeException) ErrorMessage

func (e *PayloadTooLargeException) ErrorMessage() string

type ReplicateTo

type ReplicateTo string
const (
	ReplicateToNone         ReplicateTo = "NONE"
	ReplicateToSsm_document ReplicateTo = "SSM_DOCUMENT"
)

Enum values for ReplicateTo

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ResourceName *string
}

The requested resource could not be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string
}

The number of hosted configuration versions exceeds the limit for the AppConfig configuration store. Delete one or more versions and try again.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type TriggeredBy

type TriggeredBy string
const (
	TriggeredByUser             TriggeredBy = "USER"
	TriggeredByAppconfig        TriggeredBy = "APPCONFIG"
	TriggeredByCloudwatch_alarm TriggeredBy = "CLOUDWATCH_ALARM"
	TriggeredByInternal_error   TriggeredBy = "INTERNAL_ERROR"
)

Enum values for TriggeredBy

type Validator

type Validator struct {

	// Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS
	// Lambda function.
	//
	// This member is required.
	Content *string

	// AppConfig supports validators of type JSON_SCHEMA and LAMBDA
	//
	// This member is required.
	Type ValidatorType
}

A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

type ValidatorType

type ValidatorType string
const (
	ValidatorTypeJson_schema ValidatorType = "JSON_SCHEMA"
	ValidatorTypeLambda      ValidatorType = "LAMBDA"
)

Enum values for ValidatorType

Source Files

enums.go errors.go types.go

Version
v0.28.0
Published
Oct 26, 2020
Platform
js/wasm
Imports
3 packages
Last checked
1 week ago

Tools for package owners.