package appconfig
import "github.com/aws/aws-sdk-go-v2/service/appconfig"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
- func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateConfigurationProfileInput, optFns ...func(*Options)) (*CreateConfigurationProfileOutput, error)
- func (c *Client) CreateDeploymentStrategy(ctx context.Context, params *CreateDeploymentStrategyInput, optFns ...func(*Options)) (*CreateDeploymentStrategyOutput, error)
- func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
- func (c *Client) CreateHostedConfigurationVersion(ctx context.Context, params *CreateHostedConfigurationVersionInput, optFns ...func(*Options)) (*CreateHostedConfigurationVersionOutput, error)
- func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
- func (c *Client) DeleteConfigurationProfile(ctx context.Context, params *DeleteConfigurationProfileInput, optFns ...func(*Options)) (*DeleteConfigurationProfileOutput, error)
- func (c *Client) DeleteDeploymentStrategy(ctx context.Context, params *DeleteDeploymentStrategyInput, optFns ...func(*Options)) (*DeleteDeploymentStrategyOutput, error)
- func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
- func (c *Client) DeleteHostedConfigurationVersion(ctx context.Context, params *DeleteHostedConfigurationVersionInput, optFns ...func(*Options)) (*DeleteHostedConfigurationVersionOutput, error)
- func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
- func (c *Client) GetConfiguration(ctx context.Context, params *GetConfigurationInput, optFns ...func(*Options)) (*GetConfigurationOutput, error)
- func (c *Client) GetConfigurationProfile(ctx context.Context, params *GetConfigurationProfileInput, optFns ...func(*Options)) (*GetConfigurationProfileOutput, error)
- func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
- func (c *Client) GetDeploymentStrategy(ctx context.Context, params *GetDeploymentStrategyInput, optFns ...func(*Options)) (*GetDeploymentStrategyOutput, error)
- func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
- func (c *Client) GetHostedConfigurationVersion(ctx context.Context, params *GetHostedConfigurationVersionInput, optFns ...func(*Options)) (*GetHostedConfigurationVersionOutput, error)
- func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
- func (c *Client) ListConfigurationProfiles(ctx context.Context, params *ListConfigurationProfilesInput, optFns ...func(*Options)) (*ListConfigurationProfilesOutput, error)
- func (c *Client) ListDeploymentStrategies(ctx context.Context, params *ListDeploymentStrategiesInput, optFns ...func(*Options)) (*ListDeploymentStrategiesOutput, error)
- func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
- func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
- func (c *Client) ListHostedConfigurationVersions(ctx context.Context, params *ListHostedConfigurationVersionsInput, optFns ...func(*Options)) (*ListHostedConfigurationVersionsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error)
- func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput, optFns ...func(*Options)) (*StopDeploymentOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
- func (c *Client) UpdateConfigurationProfile(ctx context.Context, params *UpdateConfigurationProfileInput, optFns ...func(*Options)) (*UpdateConfigurationProfileOutput, error)
- func (c *Client) UpdateDeploymentStrategy(ctx context.Context, params *UpdateDeploymentStrategyInput, optFns ...func(*Options)) (*UpdateDeploymentStrategyOutput, error)
- func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)
- func (c *Client) ValidateConfiguration(ctx context.Context, params *ValidateConfigurationInput, optFns ...func(*Options)) (*ValidateConfigurationOutput, error)
- type CreateApplicationInput
- type CreateApplicationOutput
- type CreateConfigurationProfileInput
- type CreateConfigurationProfileOutput
- type CreateDeploymentStrategyInput
- type CreateDeploymentStrategyOutput
- type CreateEnvironmentInput
- type CreateEnvironmentOutput
- type CreateHostedConfigurationVersionInput
- type CreateHostedConfigurationVersionOutput
- type DeleteApplicationInput
- type DeleteApplicationOutput
- type DeleteConfigurationProfileInput
- type DeleteConfigurationProfileOutput
- type DeleteDeploymentStrategyInput
- type DeleteDeploymentStrategyOutput
- type DeleteEnvironmentInput
- type DeleteEnvironmentOutput
- type DeleteHostedConfigurationVersionInput
- type DeleteHostedConfigurationVersionOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetApplicationInput
- type GetApplicationOutput
- type GetConfigurationInput
- type GetConfigurationOutput
- type GetConfigurationProfileInput
- type GetConfigurationProfileOutput
- type GetDeploymentInput
- type GetDeploymentOutput
- type GetDeploymentStrategyInput
- type GetDeploymentStrategyOutput
- type GetEnvironmentInput
- type GetEnvironmentOutput
- type GetHostedConfigurationVersionInput
- type GetHostedConfigurationVersionOutput
- type HTTPClient
- type HTTPSignerV4
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListConfigurationProfilesInput
- type ListConfigurationProfilesOutput
- type ListDeploymentStrategiesInput
- type ListDeploymentStrategiesOutput
- type ListDeploymentsInput
- type ListDeploymentsOutput
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListHostedConfigurationVersionsInput
- type ListHostedConfigurationVersionsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type StartDeploymentInput
- type StartDeploymentOutput
- type StopDeploymentInput
- type StopDeploymentOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApplicationInput
- type UpdateApplicationOutput
- type UpdateConfigurationProfileInput
- type UpdateConfigurationProfileOutput
- type UpdateDeploymentStrategyInput
- type UpdateDeploymentStrategyOutput
- type UpdateEnvironmentInput
- type UpdateEnvironmentOutput
- type ValidateConfigurationInput
- type ValidateConfigurationOutput
Constants ¶
const ServiceAPIVersion = "2019-10-09"
const ServiceID = "AppConfig"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS AppConfig Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices. <p>To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works 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.</p> <p>During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version. </p> <p>AppConfig supports multiple use cases. Here are some examples.</p> <ul> <li> <p> <b>Application tuning</b>: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.</p> </li> <li> <p> <b>Feature toggle</b>: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement. </p> </li> <li> <p> <b>Allow list</b>: Use AppConfig to allow premium subscribers to access paid content. </p> </li> <li> <p> <b>Operational issues</b>: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.</p> </li> </ul> <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html">AWS AppConfig User Guide</a>.</p>
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateApplication ¶
func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
func (*Client) CreateConfigurationProfile ¶
func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateConfigurationProfileInput, optFns ...func(*Options)) (*CreateConfigurationProfileOutput, error)
Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.
The Uri location of the configuration data.
*
The AWS Identity and Access Management (IAM) role that provides access to the configuration data.
- A validator for the configuration data. Available
validators include either a JSON Schema or an AWS Lambda function.
For more information, see Create a Configuration and a Configuration Profile (http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html) in the AWS AppConfig User Guide.
func (*Client) CreateDeploymentStrategy ¶
func (c *Client) CreateDeploymentStrategy(ctx context.Context, params *CreateDeploymentStrategyInput, optFns ...func(*Options)) (*CreateDeploymentStrategyOutput, error)
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
func (*Client) CreateEnvironment ¶
func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
func (*Client) CreateHostedConfigurationVersion ¶
func (c *Client) CreateHostedConfigurationVersion(ctx context.Context, params *CreateHostedConfigurationVersionInput, optFns ...func(*Options)) (*CreateHostedConfigurationVersionOutput, error)
Create a new configuration in the AppConfig configuration store.
func (*Client) DeleteApplication ¶
func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
Delete an application. Deleting an application does not delete a configuration from a host.
func (*Client) DeleteConfigurationProfile ¶
func (c *Client) DeleteConfigurationProfile(ctx context.Context, params *DeleteConfigurationProfileInput, optFns ...func(*Options)) (*DeleteConfigurationProfileOutput, error)
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
func (*Client) DeleteDeploymentStrategy ¶
func (c *Client) DeleteDeploymentStrategy(ctx context.Context, params *DeleteDeploymentStrategyInput, optFns ...func(*Options)) (*DeleteDeploymentStrategyOutput, error)
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
func (*Client) DeleteEnvironment ¶
func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
Delete an environment. Deleting an environment does not delete a configuration from a host.
func (*Client) DeleteHostedConfigurationVersion ¶
func (c *Client) DeleteHostedConfigurationVersion(ctx context.Context, params *DeleteHostedConfigurationVersionInput, optFns ...func(*Options)) (*DeleteHostedConfigurationVersionOutput, error)
Delete a version of a configuration from the AppConfig configuration store.
func (*Client) GetApplication ¶
func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
Retrieve information about an application.
func (*Client) GetConfiguration ¶
func (c *Client) GetConfiguration(ctx context.Context, params *GetConfigurationInput, optFns ...func(*Options)) (*GetConfigurationOutput, error)
Receive information about a configuration. AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration. To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.
func (*Client) GetConfigurationProfile ¶
func (c *Client) GetConfigurationProfile(ctx context.Context, params *GetConfigurationProfileInput, optFns ...func(*Options)) (*GetConfigurationProfileOutput, error)
Retrieve information about a configuration profile.
func (*Client) GetDeployment ¶
func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
Retrieve information about a configuration deployment.
func (*Client) GetDeploymentStrategy ¶
func (c *Client) GetDeploymentStrategy(ctx context.Context, params *GetDeploymentStrategyInput, optFns ...func(*Options)) (*GetDeploymentStrategyOutput, error)
Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
func (*Client) GetEnvironment ¶
func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
func (*Client) GetHostedConfigurationVersion ¶
func (c *Client) GetHostedConfigurationVersion(ctx context.Context, params *GetHostedConfigurationVersionInput, optFns ...func(*Options)) (*GetHostedConfigurationVersionOutput, error)
Get information about a specific configuration version.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
List all applications in your AWS account.
func (*Client) ListConfigurationProfiles ¶
func (c *Client) ListConfigurationProfiles(ctx context.Context, params *ListConfigurationProfilesInput, optFns ...func(*Options)) (*ListConfigurationProfilesOutput, error)
Lists the configuration profiles for an application.
func (*Client) ListDeploymentStrategies ¶
func (c *Client) ListDeploymentStrategies(ctx context.Context, params *ListDeploymentStrategiesInput, optFns ...func(*Options)) (*ListDeploymentStrategiesOutput, error)
List deployment strategies.
func (*Client) ListDeployments ¶
func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
Lists the deployments for an environment.
func (*Client) ListEnvironments ¶
func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
List the environments for an application.
func (*Client) ListHostedConfigurationVersions ¶
func (c *Client) ListHostedConfigurationVersions(ctx context.Context, params *ListHostedConfigurationVersionsInput, optFns ...func(*Options)) (*ListHostedConfigurationVersionsOutput, error)
View a list of configurations stored in the AppConfig configuration store by version.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Retrieves the list of key-value tags assigned to the resource.
func (*Client) StartDeployment ¶
func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error)
Starts a deployment.
func (*Client) StopDeployment ¶
func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput, optFns ...func(*Options)) (*StopDeploymentOutput, error)
Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Deletes a tag key and value from an AppConfig resource.
func (*Client) UpdateApplication ¶
func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)
Updates an application.
func (*Client) UpdateConfigurationProfile ¶
func (c *Client) UpdateConfigurationProfile(ctx context.Context, params *UpdateConfigurationProfileInput, optFns ...func(*Options)) (*UpdateConfigurationProfileOutput, error)
Updates a configuration profile.
func (*Client) UpdateDeploymentStrategy ¶
func (c *Client) UpdateDeploymentStrategy(ctx context.Context, params *UpdateDeploymentStrategyInput, optFns ...func(*Options)) (*UpdateDeploymentStrategyOutput, error)
Updates a deployment strategy.
func (*Client) UpdateEnvironment ¶
func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error)
Updates an environment.
func (*Client) ValidateConfiguration ¶
func (c *Client) ValidateConfiguration(ctx context.Context, params *ValidateConfigurationInput, optFns ...func(*Options)) (*ValidateConfigurationOutput, error)
Uses the validators in a configuration profile to validate a configuration.
type CreateApplicationInput ¶
type CreateApplicationInput struct { // A name for the application. // // This member is required. Name *string // Metadata to assign to the application. Tags help organize and categorize your // AppConfig resources. Each tag consists of a key and an optional value, both of // which you define. Tags map[string]*string // A description of the application. Description *string }
type CreateApplicationOutput ¶
type CreateApplicationOutput struct { // The application name. Name *string // The application ID. Id *string // The description of the application. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateConfigurationProfileInput ¶
type CreateConfigurationProfileInput struct { // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string // A list of methods for validating the configuration. Validators []*types.Validator // A name for the configuration profile. // // This member is required. Name *string // The application ID. // // This member is required. ApplicationId *string // Metadata to assign to the configuration profile. Tags help organize and // categorize your AppConfig resources. Each tag consists of a key and an optional // value, both of which you define. Tags map[string]*string // A description of the configuration profile. Description *string // A URI to locate the configuration. You can specify a Systems Manager (SSM) // document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM // document, specify either the document name in the format ssm-document:// or the // Amazon Resource Name (ARN). For a parameter, specify either the parameter name // in the format ssm-parameter:// or the ARN. For an Amazon S3 object, specify the // URI in the following format: s3:/// . Here is an example: // s3://my-bucket/my-app/us-east-1/my-config.json // // This member is required. LocationUri *string }
type CreateConfigurationProfileOutput ¶
type CreateConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The name of the configuration profile. Name *string // A list of methods for validating the configuration. Validators []*types.Validator // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string // The URI location of the configuration. LocationUri *string // The configuration profile ID. Id *string // The configuration profile description. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDeploymentStrategyInput ¶
type CreateDeploymentStrategyInput struct { // The percentage of targets to receive a deployed configuration during each // interval. // // This member is required. GrowthFactor *float32 // 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 // Metadata to assign to the deployment strategy. Tags help organize and categorize // your AppConfig resources. Each tag consists of a key and an optional value, both // of which you define. Tags map[string]*string // A name for the deployment strategy. // // This member is required. Name *string // Save the deployment strategy to a Systems Manager (SSM) document. // // This member is required. ReplicateTo types.ReplicateTo // Total amount of time for a deployment to last. // // This member is required. DeploymentDurationInMinutes *int32 // The algorithm used to define how percentage grows over time. AWS AppConfig // supports the following growth types: Linear: For this type, AppConfig processes // the deployment by dividing the total number of targets by the value specified // for Step percentage. For example, a linear deployment that uses a Step // percentage of 10 deploys the configuration to 10 percent of the hosts. After // those deployments are complete, the system deploys the configuration to the next // 10 percent. This continues until 100% of the targets have successfully received // the configuration. <p> <b>Exponential</b>: For this type, AppConfig processes // the deployment exponentially using the following formula: <code>G*(2^N)</code>. // In this formula, <code>G</code> is the growth factor specified by the user and // <code>N</code> is the number of steps until the configuration is deployed to all // targets. For example, if you specify a growth factor of 2, then the system rolls // out the configuration as follows:</p> <p> <code>2*(2^0)</code> </p> <p> // <code>2*(2^1)</code> </p> <p> <code>2*(2^2)</code> </p> <p>Expressed // numerically, the deployment rolls out as follows: 2% of the targets, 4% of the // targets, 8% of the targets, and continues until the configuration has been // deployed to all targets.</p> GrowthType types.GrowthType // A description of the deployment strategy. Description *string }
type CreateDeploymentStrategyOutput ¶
type CreateDeploymentStrategyOutput struct { // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // Save the deployment strategy to a Systems Manager (SSM) document. ReplicateTo types.ReplicateTo // The deployment strategy ID. Id *string // 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 name of the deployment strategy. Name *string // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateEnvironmentInput ¶
type CreateEnvironmentInput struct { // Metadata to assign to the environment. Tags help organize and categorize your // AppConfig resources. Each tag consists of a key and an optional value, both of // which you define. Tags map[string]*string // Amazon CloudWatch alarms to monitor during the deployment process. Monitors []*types.Monitor // A description of the environment. Description *string // A name for the environment. // // This member is required. Name *string // The application ID. // // This member is required. ApplicationId *string }
type CreateEnvironmentOutput ¶
type CreateEnvironmentOutput struct { // The name of the environment. Name *string // The application ID. ApplicationId *string // The description of the environment. Description *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 types.EnvironmentState // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateHostedConfigurationVersionInput ¶
type CreateHostedConfigurationVersionInput struct { // An optional locking token used to prevent race conditions from overwriting // configuration updates when creating a new version. To ensure your data is not // overwritten when creating multiple hosted configuration versions in rapid // succession, specify the version of the latest hosted configuration version. LatestVersionNumber *int32 // The content of the configuration or the configuration data. // // This member is required. Content []byte // A description of the configuration. Description *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). // // This member is required. ContentType *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The application ID. // // This member is required. ApplicationId *string }
type CreateHostedConfigurationVersionOutput ¶
type CreateHostedConfigurationVersionOutput struct { // 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 profile ID. ConfigurationProfileId *string // The configuration version. VersionNumber *int32 // The application ID. ApplicationId *string // The content of the configuration or the configuration data. Content []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApplicationInput ¶
type DeleteApplicationInput struct { // The ID of the application to delete. // // This member is required. ApplicationId *string }
type DeleteApplicationOutput ¶
type DeleteApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteConfigurationProfileInput ¶
type DeleteConfigurationProfileInput struct { // The application ID that includes the configuration profile you want to delete. // // This member is required. ApplicationId *string // The ID of the configuration profile you want to delete. // // This member is required. ConfigurationProfileId *string }
type DeleteConfigurationProfileOutput ¶
type DeleteConfigurationProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDeploymentStrategyInput ¶
type DeleteDeploymentStrategyInput struct { // The ID of the deployment strategy you want to delete. // // This member is required. DeploymentStrategyId *string }
type DeleteDeploymentStrategyOutput ¶
type DeleteDeploymentStrategyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteEnvironmentInput ¶
type DeleteEnvironmentInput struct { // The ID of the environment you want to delete. // // This member is required. EnvironmentId *string // The application ID that includes the environment you want to delete. // // This member is required. ApplicationId *string }
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteHostedConfigurationVersionInput ¶
type DeleteHostedConfigurationVersionInput struct { // The application ID. // // This member is required. ApplicationId *string // The versions number to delete. // // This member is required. VersionNumber *int32 // The configuration profile ID. // // This member is required. ConfigurationProfileId *string }
type DeleteHostedConfigurationVersionOutput ¶
type DeleteHostedConfigurationVersionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type GetApplicationInput ¶
type GetApplicationInput struct { // The ID of the application you want to get. // // This member is required. ApplicationId *string }
type GetApplicationOutput ¶
type GetApplicationOutput struct { // The application name. Name *string // The application ID. Id *string // The description of the application. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetConfigurationInput ¶
type GetConfigurationInput struct { // The environment to get. Specify either the environment name or the environment // ID. // // This member is required. Environment *string // The configuration to get. Specify either the configuration name or the // configuration ID. // // This member is required. Configuration *string // A unique ID to identify the client for the configuration. This ID enables // AppConfig to deploy the configuration in intervals, as defined in the deployment // strategy. // // This member is required. ClientId *string // The application to get. Specify either the application name or the application // ID. // // This member is required. Application *string // The configuration version returned in the most recent GetConfiguration response. // AWS AppConfig uses the value of the ClientConfigurationVersion parameter to // identify the configuration version on your clients. If you don’t send // ClientConfigurationVersion with each call to GetConfiguration, your clients // receive the current configuration. You are charged each time your clients // receive a configuration. To avoid excess charges, we recommend that you include // the ClientConfigurationVersion value with every call to GetConfiguration. This // value must be saved on your client. Subsequent calls to GetConfiguration must // pass this value by using the ClientConfigurationVersion parameter. For more // information about working with configurations, see Retrieving the Configuration // (https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-retrieving-the-configuration.html) // in the AWS AppConfig User Guide. ClientConfigurationVersion *string }
type GetConfigurationOutput ¶
type GetConfigurationOutput struct { // The content of the configuration or the configuration data. Content []byte // A standard MIME type describing the format of the configuration content. For // more information, see Content-Type // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string // The configuration version. ConfigurationVersion *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetConfigurationProfileInput ¶
type GetConfigurationProfileInput struct { // The ID of the configuration profile you want to get. // // This member is required. ConfigurationProfileId *string // The ID of the application that includes the configuration profile you want to // get. // // This member is required. ApplicationId *string }
type GetConfigurationProfileOutput ¶
type GetConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The name of the configuration profile. Name *string // A list of methods for validating the configuration. Validators []*types.Validator // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string // The URI location of the configuration. LocationUri *string // The configuration profile ID. Id *string // The configuration profile description. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDeploymentInput ¶
type GetDeploymentInput struct { // The ID of the environment that includes the deployment you want to get. // // This member is required. EnvironmentId *string // The ID of the application that includes the deployment you want to get. // // This member is required. ApplicationId *string // The sequence number of the deployment. // // This member is required. DeploymentNumber *int32 }
type GetDeploymentOutput ¶
type GetDeploymentOutput struct { // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The ID of the application that was deployed. ApplicationId *string // Information about the source location of the configuration. ConfigurationLocationUri *string // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // The percentage of targets for which the deployment is available. PercentageComplete *float32 // The state of the deployment. State types.DeploymentState // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []*types.DeploymentEvent // The configuration version that was deployed. ConfigurationVersion *string // The description of the deployment. Description *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // 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 time the deployment started. StartedAt *time.Time // The sequence number of the deployment. DeploymentNumber *int32 // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 // The time the deployment completed. CompletedAt *time.Time // The name of the configuration. ConfigurationName *string // The ID of the environment that was deployed. EnvironmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDeploymentStrategyInput ¶
type GetDeploymentStrategyInput struct { // The ID of the deployment strategy to get. // // This member is required. DeploymentStrategyId *string }
type GetDeploymentStrategyOutput ¶
type GetDeploymentStrategyOutput struct { // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // Save the deployment strategy to a Systems Manager (SSM) document. ReplicateTo types.ReplicateTo // The deployment strategy ID. Id *string // 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 name of the deployment strategy. Name *string // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetEnvironmentInput ¶
type GetEnvironmentInput struct { // The ID of the environment you wnat to get. // // This member is required. EnvironmentId *string // The ID of the application that includes the environment you want to get. // // This member is required. ApplicationId *string }
type GetEnvironmentOutput ¶
type GetEnvironmentOutput struct { // The name of the environment. Name *string // The application ID. ApplicationId *string // The description of the environment. Description *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 types.EnvironmentState // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetHostedConfigurationVersionInput ¶
type GetHostedConfigurationVersionInput struct { // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The application ID. // // This member is required. ApplicationId *string // The version. // // This member is required. VersionNumber *int32 }
type GetHostedConfigurationVersionOutput ¶
type GetHostedConfigurationVersionOutput struct { // 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 profile ID. ConfigurationProfileId *string // The configuration version. VersionNumber *int32 // The application ID. ApplicationId *string // The content of the configuration or the configuration data. Content []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListApplicationsInput ¶
type ListApplicationsInput struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string }
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The elements from this collection. Items []*types.Application // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListConfigurationProfilesInput ¶
type ListConfigurationProfilesInput struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // The application ID. // // This member is required. ApplicationId *string }
type ListConfigurationProfilesOutput ¶
type ListConfigurationProfilesOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The elements from this collection. Items []*types.ConfigurationProfileSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDeploymentStrategiesInput ¶
type ListDeploymentStrategiesInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 }
type ListDeploymentStrategiesOutput ¶
type ListDeploymentStrategiesOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The elements from this collection. Items []*types.DeploymentStrategy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDeploymentsInput ¶
type ListDeploymentsInput struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // The application ID. // // This member is required. ApplicationId *string // The environment ID. // // This member is required. EnvironmentId *string }
type ListDeploymentsOutput ¶
type ListDeploymentsOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The elements from this collection. Items []*types.DeploymentSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListEnvironmentsInput ¶
type ListEnvironmentsInput struct { // The application ID. // // This member is required. ApplicationId *string // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string }
type ListEnvironmentsOutput ¶
type ListEnvironmentsOutput struct { // The elements from this collection. Items []*types.Environment // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListHostedConfigurationVersionsInput ¶
type ListHostedConfigurationVersionsInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string // The application ID. // // This member is required. ApplicationId *string // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // The configuration profile ID. // // This member is required. ConfigurationProfileId *string }
type ListHostedConfigurationVersionsOutput ¶
type ListHostedConfigurationVersionsOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The elements from this collection. Items []*types.HostedConfigurationVersionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The resource ARN. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Metadata to assign to AppConfig resources. Tags help organize and categorize // your AppConfig resources. Each tag consists of a key and an optional value, both // of which you define. Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartDeploymentInput ¶
type StartDeploymentInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration version to deploy. // // This member is required. ConfigurationVersion *string // The deployment strategy ID. // // This member is required. DeploymentStrategyId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // A description of the deployment. Description *string // The environment ID. // // This member is required. EnvironmentId *string // Metadata to assign to the deployment. Tags help organize and categorize your // AppConfig resources. Each tag consists of a key and an optional value, both of // which you define. Tags map[string]*string }
type StartDeploymentOutput ¶
type StartDeploymentOutput struct { // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The ID of the application that was deployed. ApplicationId *string // Information about the source location of the configuration. ConfigurationLocationUri *string // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // The percentage of targets for which the deployment is available. PercentageComplete *float32 // The state of the deployment. State types.DeploymentState // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []*types.DeploymentEvent // The configuration version that was deployed. ConfigurationVersion *string // The description of the deployment. Description *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // 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 time the deployment started. StartedAt *time.Time // The sequence number of the deployment. DeploymentNumber *int32 // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 // The time the deployment completed. CompletedAt *time.Time // The name of the configuration. ConfigurationName *string // The ID of the environment that was deployed. EnvironmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopDeploymentInput ¶
type StopDeploymentInput struct { // The environment ID. // // This member is required. EnvironmentId *string // The sequence number of the deployment. // // This member is required. DeploymentNumber *int32 // The application ID. // // This member is required. ApplicationId *string }
type StopDeploymentOutput ¶
type StopDeploymentOutput struct { // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The ID of the application that was deployed. ApplicationId *string // Information about the source location of the configuration. ConfigurationLocationUri *string // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // The percentage of targets for which the deployment is available. PercentageComplete *float32 // The state of the deployment. State types.DeploymentState // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []*types.DeploymentEvent // The configuration version that was deployed. ConfigurationVersion *string // The description of the deployment. Description *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // 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 time the deployment started. StartedAt *time.Time // The sequence number of the deployment. DeploymentNumber *int32 // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float32 // The time the deployment completed. CompletedAt *time.Time // The name of the configuration. ConfigurationName *string // The ID of the environment that was deployed. EnvironmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // The ARN of the resource for which to retrieve tags. // // This member is required. ResourceArn *string // The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag // key can be up to 128 characters and must not start with aws:. The tag value can // be up to 256 characters. // // This member is required. Tags map[string]*string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The tag keys to delete. // // This member is required. TagKeys []*string // The ARN of the resource for which to remove tags. // // This member is required. ResourceArn *string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateApplicationInput ¶
type UpdateApplicationInput struct { // A description of the application. Description *string // The name of the application. Name *string // The application ID. // // This member is required. ApplicationId *string }
type UpdateApplicationOutput ¶
type UpdateApplicationOutput struct { // The application name. Name *string // The application ID. Id *string // The description of the application. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateConfigurationProfileInput ¶
type UpdateConfigurationProfileInput struct { // The name of the configuration profile. Name *string // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string // The application ID. // // This member is required. ApplicationId *string // The ID of the configuration profile. // // This member is required. ConfigurationProfileId *string // A description of the configuration profile. Description *string // A list of methods for validating the configuration. Validators []*types.Validator }
type UpdateConfigurationProfileOutput ¶
type UpdateConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The name of the configuration profile. Name *string // A list of methods for validating the configuration. Validators []*types.Validator // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. RetrievalRoleArn *string // The URI location of the configuration. LocationUri *string // The configuration profile ID. Id *string // The configuration profile description. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDeploymentStrategyInput ¶
type UpdateDeploymentStrategyInput struct { // A description of the deployment strategy. Description *string // The algorithm used to define how percentage grows over time. AWS AppConfig // supports the following growth types: Linear: For this type, AppConfig processes // the deployment by increments of the growth factor evenly distributed over the // deployment time. For example, a linear deployment that uses a growth factor of // 20 initially makes the configuration available to 20 percent of the targets. // After 1/5th of the deployment time has passed, the system updates the percentage // to 40 percent. This continues until 100% of the targets are set to receive the // deployed configuration. <p> <b>Exponential</b>: For this type, AppConfig // processes the deployment exponentially using the following formula: // <code>G*(2^N)</code>. In this formula, <code>G</code> is the growth factor // specified by the user and <code>N</code> is the number of steps until the // configuration is deployed to all targets. For example, if you specify a growth // factor of 2, then the system rolls out the configuration as follows:</p> <p> // <code>2*(2^0)</code> </p> <p> <code>2*(2^1)</code> </p> <p> <code>2*(2^2)</code> // </p> <p>Expressed numerically, the deployment rolls out as follows: 2% of the // targets, 4% of the targets, 8% of the targets, and continues until the // configuration has been deployed to all targets.</p> GrowthType types.GrowthType // Total amount of time for a deployment to last. DeploymentDurationInMinutes *int32 // The deployment strategy ID. // // This member is required. DeploymentStrategyId *string // 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 }
type UpdateDeploymentStrategyOutput ¶
type UpdateDeploymentStrategyOutput struct { // The algorithm used to define how percentage grew over time. GrowthType types.GrowthType // Total amount of time the deployment lasted. DeploymentDurationInMinutes *int32 // Save the deployment strategy to a Systems Manager (SSM) document. ReplicateTo types.ReplicateTo // The deployment strategy ID. Id *string // 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 name of the deployment strategy. Name *string // The percentage of targets that received a deployed configuration during each // interval. GrowthFactor *float32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateEnvironmentInput ¶
type UpdateEnvironmentInput struct { // A description of the environment. Description *string // Amazon CloudWatch alarms to monitor during the deployment process. Monitors []*types.Monitor // The environment ID. // // This member is required. EnvironmentId *string // The name of the environment. Name *string // The application ID. // // This member is required. ApplicationId *string }
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput struct { // The name of the environment. Name *string // The application ID. ApplicationId *string // The description of the environment. Description *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 types.EnvironmentState // The environment ID. Id *string // Amazon CloudWatch alarms monitored during the deployment. Monitors []*types.Monitor // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ValidateConfigurationInput ¶
type ValidateConfigurationInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The version of the configuration to validate. // // This member is required. ConfigurationVersion *string }
type ValidateConfigurationOutput ¶
type ValidateConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CreateApplication.go api_op_CreateConfigurationProfile.go api_op_CreateDeploymentStrategy.go api_op_CreateEnvironment.go api_op_CreateHostedConfigurationVersion.go api_op_DeleteApplication.go api_op_DeleteConfigurationProfile.go api_op_DeleteDeploymentStrategy.go api_op_DeleteEnvironment.go api_op_DeleteHostedConfigurationVersion.go api_op_GetApplication.go api_op_GetConfiguration.go api_op_GetConfigurationProfile.go api_op_GetDeployment.go api_op_GetDeploymentStrategy.go api_op_GetEnvironment.go api_op_GetHostedConfigurationVersion.go api_op_ListApplications.go api_op_ListConfigurationProfiles.go api_op_ListDeploymentStrategies.go api_op_ListDeployments.go api_op_ListEnvironments.go api_op_ListHostedConfigurationVersions.go api_op_ListTagsForResource.go api_op_StartDeployment.go api_op_StopDeployment.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateApplication.go api_op_UpdateConfigurationProfile.go api_op_UpdateDeploymentStrategy.go api_op_UpdateEnvironment.go api_op_ValidateConfiguration.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 28 packages
- Last checked
- 1 week ago –
Tools for package owners.