types

package
v1.29.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 2

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action added in v1.13.0

type Action struct {

	// Information about the action.
	Description *string

	// The action name.
	Name *string

	// An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
	RoleArn *string

	// The extension URI associated to the action point in the extension definition.
	// The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda
	// function, an Amazon Simple Queue Service queue, an Amazon Simple Notification
	// Service topic, or the Amazon EventBridge default event bus.
	Uri *string
	// contains filtered or unexported fields
}

An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION
  • PRE_START_DEPLOYMENT
  • ON_DEPLOYMENT_START
  • ON_DEPLOYMENT_STEP
  • ON_DEPLOYMENT_BAKING
  • ON_DEPLOYMENT_COMPLETE
  • ON_DEPLOYMENT_ROLLED_BACK

type ActionInvocation added in v1.13.0

type ActionInvocation struct {

	// The name of the action.
	ActionName *string

	// The error code when an extension invocation fails.
	ErrorCode *string

	// The error message when an extension invocation fails.
	ErrorMessage *string

	// The name, the ID, or the Amazon Resource Name (ARN) of the extension.
	ExtensionIdentifier *string

	// A system-generated ID for this invocation.
	InvocationId *string

	// An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
	RoleArn *string

	// The extension URI associated to the action point in the extension definition.
	// The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda
	// function, an Amazon Simple Queue Service queue, an Amazon Simple Notification
	// Service topic, or the Amazon EventBridge default event bus.
	Uri *string
	// contains filtered or unexported fields
}

An extension that was invoked as part of a deployment event.

type ActionPoint added in v1.13.0

type ActionPoint string
const (
	ActionPointPreCreateHostedConfigurationVersion ActionPoint = "PRE_CREATE_HOSTED_CONFIGURATION_VERSION"
	ActionPointPreStartDeployment                  ActionPoint = "PRE_START_DEPLOYMENT"
	ActionPointOnDeploymentStart                   ActionPoint = "ON_DEPLOYMENT_START"
	ActionPointOnDeploymentStep                    ActionPoint = "ON_DEPLOYMENT_STEP"
	ActionPointOnDeploymentBaking                  ActionPoint = "ON_DEPLOYMENT_BAKING"
	ActionPointOnDeploymentComplete                ActionPoint = "ON_DEPLOYMENT_COMPLETE"
	ActionPointOnDeploymentRolledBack              ActionPoint = "ON_DEPLOYMENT_ROLLED_BACK"
)

Enum values for ActionPoint

func (ActionPoint) Values added in v1.13.0

func (ActionPoint) Values() []ActionPoint

Values returns all known values for ActionPoint. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Application

type Application struct {

	// The description of the application.
	Description *string

	// The application ID.
	Id *string

	// The application name.
	Name *string
	// contains filtered or unexported fields
}

type AppliedExtension added in v1.13.0

type AppliedExtension struct {

	// The system-generated ID for the association.
	ExtensionAssociationId *string

	// The system-generated ID of the extension.
	ExtensionId *string

	// One or more parameters for the actions called by the extension.
	Parameters map[string]string

	// The extension version number.
	VersionNumber int32
	// contains filtered or unexported fields
}

An extension that was invoked during a deployment.

type BadRequestDetails added in v1.7.0

type BadRequestDetails interface {
	// contains filtered or unexported methods
}

Detailed information about the input that failed to satisfy the constraints specified by a call.

The following types satisfy this interface:

BadRequestDetailsMemberInvalidConfiguration
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

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

func main() {
	var union types.BadRequestDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.BadRequestDetailsMemberInvalidConfiguration:
		_ = v.Value // Value is []types.InvalidConfigurationDetail

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ []types.InvalidConfigurationDetail
Output:

type BadRequestDetailsMemberInvalidConfiguration added in v1.7.0

type BadRequestDetailsMemberInvalidConfiguration struct {
	Value []InvalidConfigurationDetail
	// contains filtered or unexported fields
}

Detailed information about the bad request exception error when creating a hosted configuration version.

type BadRequestException

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	Reason  BadRequestReason
	Details BadRequestDetails
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services 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 BadRequestReason added in v1.7.0

type BadRequestReason string
const (
	BadRequestReasonInvalidConfiguration BadRequestReason = "InvalidConfiguration"
)

Enum values for BadRequestReason

func (BadRequestReason) Values added in v1.7.0

Values returns all known values for BadRequestReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BytesMeasure

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

Enum values for BytesMeasure

func (BytesMeasure) Values added in v0.29.0

func (BytesMeasure) Values() []BytesMeasure

Values returns all known values for BytesMeasure. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 type of configurations contained in the profile. AppConfig supports feature
	// flags and freeform configurations. We recommend you create feature flag
	// configurations to enable or disable new features and freeform configurations to
	// distribute configurations to an application. When calling this API, enter one of
	// the following values for Type : AWS.AppConfig.FeatureFlags
	//     AWS.Freeform
	Type *string

	// The types of validators in the configuration profile.
	ValidatorTypes []ValidatorType
	// contains filtered or unexported fields
}

A summary of a configuration profile.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 {

	// The list of extensions that were invoked as part of the deployment.
	ActionInvocations []ActionInvocation

	// A description of the deployment event. Descriptions include, but are not
	// limited to, the following:
	//   - The Amazon Web Services account or the Amazon CloudWatch alarm ARN that
	//   initiated a rollback.
	//   - The percentage of hosts that received the deployment.
	//   - A recommendation to attempt a new deployment (in the case of an internal
	//   error).
	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; and 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, AppConfig, an Amazon CloudWatch alarm, or an internal error.
	TriggeredBy TriggeredBy
	// contains filtered or unexported fields
}

An object that describes a deployment event.

type DeploymentEventType

type DeploymentEventType string
const (
	DeploymentEventTypePercentageUpdated   DeploymentEventType = "PERCENTAGE_UPDATED"
	DeploymentEventTypeRollbackStarted     DeploymentEventType = "ROLLBACK_STARTED"
	DeploymentEventTypeRollbackCompleted   DeploymentEventType = "ROLLBACK_COMPLETED"
	DeploymentEventTypeBakeTimeStarted     DeploymentEventType = "BAKE_TIME_STARTED"
	DeploymentEventTypeDeploymentStarted   DeploymentEventType = "DEPLOYMENT_STARTED"
	DeploymentEventTypeDeploymentCompleted DeploymentEventType = "DEPLOYMENT_COMPLETED"
)

Enum values for DeploymentEventType

func (DeploymentEventType) Values added in v0.29.0

Values returns all known values for DeploymentEventType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentState

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

Enum values for DeploymentState

func (DeploymentState) Values added in v0.29.0

func (DeploymentState) Values() []DeploymentState

Values returns all known values for DeploymentState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 that AppConfig monitored for alarms before considering the
	// deployment to be complete and no longer eligible for automatic rollback.
	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
	// contains filtered or unexported fields
}

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 that AppConfig monitors for alarms before considering the
	// deployment to be complete and no longer eligible for automatic rollback.
	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

	// A user-defined label for an AppConfig hosted configuration version.
	VersionLabel *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type EnvironmentState

type EnvironmentState string
const (
	EnvironmentStateReadyForDeployment EnvironmentState = "READY_FOR_DEPLOYMENT"
	EnvironmentStateDeploying          EnvironmentState = "DEPLOYING"
	EnvironmentStateRollingBack        EnvironmentState = "ROLLING_BACK"
	EnvironmentStateRolledBack         EnvironmentState = "ROLLED_BACK"
)

Enum values for EnvironmentState

func (EnvironmentState) Values added in v0.29.0

Values returns all known values for EnvironmentState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExtensionAssociationSummary added in v1.13.0

type ExtensionAssociationSummary struct {

	// The system-generated Amazon Resource Name (ARN) for the extension.
	ExtensionArn *string

	// The extension association ID. This ID is used to call other ExtensionAssociation
	// API actions such as GetExtensionAssociation or DeleteExtensionAssociation .
	Id *string

	// The ARNs of applications, configuration profiles, or environments defined in
	// the association.
	ResourceArn *string
	// contains filtered or unexported fields
}

Information about an association between an extension and an AppConfig resource such as an application, environment, or configuration profile. Call GetExtensionAssociation to get more information about an association.

type ExtensionSummary added in v1.13.0

type ExtensionSummary struct {

	// The system-generated Amazon Resource Name (ARN) for the extension.
	Arn *string

	// Information about the extension.
	Description *string

	// The system-generated ID of the extension.
	Id *string

	// The extension name.
	Name *string

	// The extension version number.
	VersionNumber int32
	// contains filtered or unexported fields
}

Information about an extension. Call GetExtension to get more information about an extension.

type GrowthType

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

Enum values for GrowthType

func (GrowthType) Values added in v0.29.0

func (GrowthType) Values() []GrowthType

Values returns all known values for GrowthType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)
	// .
	ContentType *string

	// A description of the configuration.
	Description *string

	// The Amazon Resource Name of the Key Management Service key that was used to
	// encrypt this specific version of the configuration data in the AppConfig hosted
	// configuration store.
	KmsKeyArn *string

	// A user-defined label for an AppConfig hosted configuration version.
	VersionLabel *string

	// The configuration version.
	VersionNumber int32
	// contains filtered or unexported fields
}

Information about the configuration.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 InvalidConfigurationDetail added in v1.7.0

type InvalidConfigurationDetail struct {

	// The invalid or out-of-range validation constraint in your JSON schema that
	// failed validation.
	Constraint *string

	// Location of the validation constraint in the configuration JSON schema that
	// failed validation.
	Location *string

	// The reason for an invalid configuration error.
	Reason *string

	// The type of error for an invalid configuration.
	Type *string

	// Details about an error with Lambda when a synchronous extension experiences an
	// error during an invocation.
	Value *string
	// contains filtered or unexported fields
}

Detailed information about the bad request exception error when creating a hosted configuration version.

type Monitor

type Monitor struct {

	// Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
	//
	// This member is required.
	AlarmArn *string

	// ARN of an Identity and Access Management (IAM) role for AppConfig to monitor
	// AlarmArn .
	AlarmRoleArn *string
	// contains filtered or unexported fields
}

Amazon CloudWatch alarms to monitor during the deployment process.

type Parameter added in v1.13.0

type Parameter struct {

	// Information about the parameter.
	Description *string

	// Indicates whether this parameter's value can be supplied at the extension's
	// action point instead of during extension association. Dynamic parameters can't
	// be marked Required .
	Dynamic bool

	// A parameter value must be specified in the extension association.
	Required bool
	// contains filtered or unexported fields
}

A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) in the AppConfig User Guide.

type PayloadTooLargeException

type PayloadTooLargeException struct {
	Message *string

	ErrorCodeOverride *string

	Measure BytesMeasure
	Limit   float32
	Size    float32
	// contains filtered or unexported fields
}

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"
	ReplicateToSsmDocument ReplicateTo = "SSM_DOCUMENT"
)

Enum values for ReplicateTo

func (ReplicateTo) Values added in v0.29.0

func (ReplicateTo) Values() []ReplicateTo

Values returns all known values for ReplicateTo. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Configuration profiles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig (https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) in the Amazon Web Services General Reference.

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"
	TriggeredByCloudwatchAlarm TriggeredBy = "CLOUDWATCH_ALARM"
	TriggeredByInternalError   TriggeredBy = "INTERNAL_ERROR"
)

Enum values for TriggeredBy

func (TriggeredBy) Values added in v0.29.0

func (TriggeredBy) Values() []TriggeredBy

Values returns all known values for TriggeredBy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember added in v1.7.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type Validator

type Validator struct {

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

	// AppConfig supports validators of type JSON_SCHEMA and LAMBDA
	//
	// This member is required.
	Type ValidatorType
	// contains filtered or unexported fields
}

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services 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 (
	ValidatorTypeJsonSchema ValidatorType = "JSON_SCHEMA"
	ValidatorTypeLambda     ValidatorType = "LAMBDA"
)

Enum values for ValidatorType

func (ValidatorType) Values added in v0.29.0

func (ValidatorType) Values() []ValidatorType

Values returns all known values for ValidatorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL