Documentation ¶
Overview ¶
Package appconfig provides the API client, operations, and parameter types for Amazon AppConfig.
Use AppConfig, a capability of Amazon Web Services 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, Lambda, containers, mobile applications, or IoT devices. 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 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. 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. AppConfig supports multiple use cases. Here are some examples:
* Feature flags: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
* Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
* Allow list: Use AppConfig to allow premium subscribers to access paid content.
* Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.
This reference is intended to be used with the AppConfig User Guide (http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)
- func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateConfigurationProfileInput, ...) (*CreateConfigurationProfileOutput, error)
- func (c *Client) CreateDeploymentStrategy(ctx context.Context, params *CreateDeploymentStrategyInput, ...) (*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, ...) (*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, ...) (*DeleteConfigurationProfileOutput, error)
- func (c *Client) DeleteDeploymentStrategy(ctx context.Context, params *DeleteDeploymentStrategyInput, ...) (*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, ...) (*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)deprecated
- func (c *Client) GetConfigurationProfile(ctx context.Context, params *GetConfigurationProfileInput, ...) (*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, ...) (*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, ...) (*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, ...) (*ListConfigurationProfilesOutput, error)
- func (c *Client) ListDeploymentStrategies(ctx context.Context, params *ListDeploymentStrategiesInput, ...) (*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, ...) (*ListHostedConfigurationVersionsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*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, ...) (*UpdateConfigurationProfileOutput, error)
- func (c *Client) UpdateDeploymentStrategy(ctx context.Context, params *UpdateDeploymentStrategyInput, ...) (*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, ...) (*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 EndpointResolverOptions
- 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 ListApplicationsAPIClient
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListApplicationsPaginator
- type ListApplicationsPaginatorOptions
- type ListConfigurationProfilesAPIClient
- type ListConfigurationProfilesInput
- type ListConfigurationProfilesOutput
- type ListConfigurationProfilesPaginator
- type ListConfigurationProfilesPaginatorOptions
- type ListDeploymentStrategiesAPIClient
- type ListDeploymentStrategiesInput
- type ListDeploymentStrategiesOutput
- type ListDeploymentStrategiesPaginator
- type ListDeploymentStrategiesPaginatorOptions
- type ListDeploymentsAPIClient
- type ListDeploymentsInput
- type ListDeploymentsOutput
- type ListDeploymentsPaginator
- type ListDeploymentsPaginatorOptions
- type ListEnvironmentsAPIClient
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListEnvironmentsPaginator
- type ListEnvironmentsPaginatorOptions
- type ListHostedConfigurationVersionsAPIClient
- type ListHostedConfigurationVersionsInput
- type ListHostedConfigurationVersionsOutput
- type ListHostedConfigurationVersionsPaginator
- type ListHostedConfigurationVersionsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- 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"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon AppConfig.
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)
Creates an application. 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 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)
Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action (http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source) supported by CodePipeline. A configuration profile includes the following information:
* The URI location of the configuration data.
* The 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 Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) in the AppConfig User Guide.
func (*Client) CreateDeploymentStrategy ¶
func (c *Client) CreateDeploymentStrategy(ctx context.Context, params *CreateDeploymentStrategyInput, optFns ...func(*Options)) (*CreateDeploymentStrategyOutput, error)
Creates a deployment strategy that 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)
Creates an environment. 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)
Creates a new configuration in the AppConfig hosted configuration store.
func (*Client) DeleteApplication ¶
func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)
Deletes 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)
Deletes 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)
Deletes 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)
Deletes 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)
Deletes a version of a configuration from the AppConfig hosted configuration store.
func (*Client) GetApplication ¶
func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
Retrieves information about an application.
func (*Client) GetConfiguration
deprecated
func (c *Client) GetConfiguration(ctx context.Context, params *GetConfigurationInput, optFns ...func(*Options)) (*GetConfigurationOutput, error)
Retrieves the latest deployed configuration. Note the following important information.
* This API action has been deprecated. Calls to receive configuration data should use the StartConfigurationSession (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html) and GetLatestConfiguration (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) APIs instead.
* GetConfiguration is a priced call. For more information, see Pricing (https://aws.amazon.com/systems-manager/pricing/).
* 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 you use the StartConfigurationSession (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html) and GetLatestConfiguration (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html) APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.
Deprecated: This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.
func (*Client) GetConfigurationProfile ¶
func (c *Client) GetConfigurationProfile(ctx context.Context, params *GetConfigurationProfileInput, optFns ...func(*Options)) (*GetConfigurationProfileOutput, error)
Retrieves information about a configuration profile.
func (*Client) GetDeployment ¶
func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
Retrieves information about a configuration deployment.
func (*Client) GetDeploymentStrategy ¶
func (c *Client) GetDeploymentStrategy(ctx context.Context, params *GetDeploymentStrategyInput, optFns ...func(*Options)) (*GetDeploymentStrategyOutput, error)
Retrieves 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)
Retrieves 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)
Retrieves information about a specific configuration version.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
Lists all applications in your Amazon Web Services 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)
Lists 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 in descending deployment number order.
func (*Client) ListEnvironments ¶
func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
Lists the environments for an application.
func (*Client) ListHostedConfigurationVersions ¶
func (c *Client) ListHostedConfigurationVersions(ctx context.Context, params *ListHostedConfigurationVersionsInput, optFns ...func(*Options)) (*ListHostedConfigurationVersionsOutput, error)
Lists configurations stored in the AppConfig hosted 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)
Assigns metadata 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 // A description of the application. Description *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 // contains filtered or unexported fields }
type CreateApplicationOutput ¶
type CreateApplicationOutput struct { // The description of the application. Description *string // The application ID. Id *string // The application name. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateConfigurationProfileInput ¶
type CreateConfigurationProfileInput struct { // The application ID. // // This member is required. ApplicationId *string // A URI to locate the configuration. You can specify the AppConfig hosted // configuration store, Systems Manager (SSM) document, an SSM Parameter Store // parameter, or an Amazon S3 object. For the hosted configuration store and for // feature flags, specify hosted. 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 // A name for the configuration profile. // // This member is required. Name *string // A description of the configuration profile. Description *string // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. A retrieval role ARN is not required for configurations // stored in the AppConfig hosted configuration store. It is required for all other // sources that store your configuration. RetrievalRoleArn *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 // 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 // A list of methods for validating the configuration. Validators []types.Validator // contains filtered or unexported fields }
type CreateConfigurationProfileOutput ¶
type CreateConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The configuration profile description. Description *string // The configuration profile ID. Id *string // The URI location of the configuration. LocationUri *string // 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 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 // A list of methods for validating the configuration. Validators []types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDeploymentStrategyInput ¶
type CreateDeploymentStrategyInput struct { // Total amount of time for a deployment to last. // // This member is required. DeploymentDurationInMinutes int32 // The percentage of targets to receive a deployed configuration during each // interval. // // This member is required. GrowthFactor float32 // 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 // A description of the deployment strategy. Description *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 algorithm used to define how percentage grows over time. 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. Exponential: For this type, AppConfig processes the deployment // exponentially using the following formula: G*(2^N). In this formula, G is the // growth factor specified by the user and N 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: 2*(2^0) // // 2*(2^1) // // 2*(2^2) 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. GrowthType types.GrowthType // 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 // contains filtered or unexported fields }
type CreateDeploymentStrategyOutput ¶
type CreateDeploymentStrategyOutput 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 types.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 types.ReplicateTo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateEnvironmentInput ¶
type CreateEnvironmentInput struct { // The application ID. // // This member is required. ApplicationId *string // A name for the environment. // // This member is required. Name *string // A description of the environment. Description *string // Amazon CloudWatch alarms to monitor during the deployment process. Monitors []types.Monitor // 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 // contains filtered or unexported fields }
type CreateEnvironmentOutput ¶
type CreateEnvironmentOutput 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 []types.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 types.EnvironmentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateHostedConfigurationVersionInput ¶
type CreateHostedConfigurationVersionInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The content of the configuration or the configuration data. // // This member is required. Content []byte // 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). // // This member is required. ContentType *string // A description of the configuration. Description *string // 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 number of the latest hosted configuration // version. LatestVersionNumber int32 // contains filtered or unexported fields }
type CreateHostedConfigurationVersionOutput ¶
type CreateHostedConfigurationVersionOutput struct { // The application ID. ApplicationId *string // The configuration profile ID. ConfigurationProfileId *string // 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 // (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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteApplicationInput ¶
type DeleteApplicationInput struct { // The ID of the application to delete. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type DeleteApplicationOutput ¶
type DeleteApplicationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeleteConfigurationProfileOutput ¶
type DeleteConfigurationProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteDeploymentStrategyInput ¶
type DeleteDeploymentStrategyInput struct { // The ID of the deployment strategy you want to delete. // // This member is required. DeploymentStrategyId *string // contains filtered or unexported fields }
type DeleteDeploymentStrategyOutput ¶
type DeleteDeploymentStrategyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteEnvironmentInput ¶
type DeleteEnvironmentInput struct { // The application ID that includes the environment that you want to delete. // // This member is required. ApplicationId *string // The ID of the environment that you want to delete. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteHostedConfigurationVersionInput ¶
type DeleteHostedConfigurationVersionInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The versions number to delete. // // This member is required. VersionNumber int32 // contains filtered or unexported fields }
type DeleteHostedConfigurationVersionOutput ¶
type DeleteHostedConfigurationVersionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetApplicationInput ¶
type GetApplicationInput struct { // The ID of the application you want to get. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type GetApplicationOutput ¶
type GetApplicationOutput struct { // The description of the application. Description *string // The application ID. Id *string // The application name. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetConfigurationInput ¶
type GetConfigurationInput struct { // The application to get. Specify either the application name or the application // ID. // // This member is required. Application *string // The clientId parameter in the following command is a unique, user-specified 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 configuration to get. Specify either the configuration name or the // configuration ID. // // This member is required. Configuration *string // The environment to get. Specify either the environment name or the environment // ID. // // This member is required. Environment *string // The configuration version returned in the most recent GetConfiguration response. // 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 // (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html) // in the AppConfig User Guide. ClientConfigurationVersion *string // contains filtered or unexported fields }
type GetConfigurationOutput ¶
type GetConfigurationOutput struct { // The configuration version. ConfigurationVersion *string // The content of the configuration or the configuration data. The Content // attribute only contains data if the system finds new or updated configuration // data. If there is no new or updated data and ClientConfigurationVersion matches // the version of the current configuration, AppConfig returns a 204 No Content // HTTP response code and the Content value will be empty. 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetConfigurationProfileInput ¶
type GetConfigurationProfileInput struct { // The ID of the application that includes the configuration profile you want to // get. // // This member is required. ApplicationId *string // The ID of the configuration profile that you want to get. // // This member is required. ConfigurationProfileId *string // contains filtered or unexported fields }
type GetConfigurationProfileOutput ¶
type GetConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The configuration profile description. Description *string // The configuration profile ID. Id *string // The URI location of the configuration. LocationUri *string // 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 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 // A list of methods for validating the configuration. Validators []types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDeploymentInput ¶
type GetDeploymentInput struct { // 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 // The ID of the environment that includes the deployment you want to get. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type GetDeploymentOutput ¶
type GetDeploymentOutput struct { // The ID of the application that was deployed. ApplicationId *string // The time the deployment completed. CompletedAt *time.Time // Information about the source location of the configuration. ConfigurationLocationUri *string // The name of the configuration. ConfigurationName *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes int32 // The sequence number of the deployment. DeploymentNumber int32 // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The description of the deployment. Description *string // The ID of the environment that was deployed. EnvironmentId *string // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []types.DeploymentEvent // 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 to receive a deployed configuration during each // interval. GrowthFactor float32 // 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 time the deployment started. StartedAt *time.Time // The state of the deployment. State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDeploymentStrategyInput ¶
type GetDeploymentStrategyInput struct { // The ID of the deployment strategy to get. // // This member is required. DeploymentStrategyId *string // contains filtered or unexported fields }
type GetDeploymentStrategyOutput ¶
type GetDeploymentStrategyOutput 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 types.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 types.ReplicateTo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetEnvironmentInput ¶
type GetEnvironmentInput struct { // The ID of the application that includes the environment you want to get. // // This member is required. ApplicationId *string // The ID of the environment that you want to get. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type GetEnvironmentOutput ¶
type GetEnvironmentOutput 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 []types.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 types.EnvironmentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetHostedConfigurationVersionInput ¶
type GetHostedConfigurationVersionInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The version. // // This member is required. VersionNumber int32 // contains filtered or unexported fields }
type GetHostedConfigurationVersionOutput ¶
type GetHostedConfigurationVersionOutput struct { // The application ID. ApplicationId *string // The configuration profile ID. ConfigurationProfileId *string // 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 // (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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type ListApplicationsAPIClient ¶ added in v0.30.0
type ListApplicationsAPIClient interface {
ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}
ListApplicationsAPIClient is a client that implements the ListApplications operation.
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. Next token is a pagination token generated by // AppConfig to describe what page the previous List call ended on. For the first // List request, the nextToken should not be set. On subsequent calls, the // nextToken parameter should be set to the previous responses nextToken value. Use // this token to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // The elements from this collection. Items []types.Application // 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 // contains filtered or unexported fields }
type ListApplicationsPaginator ¶ added in v0.30.0
type ListApplicationsPaginator struct {
// contains filtered or unexported fields
}
ListApplicationsPaginator is a paginator for ListApplications
func NewListApplicationsPaginator ¶ added in v0.30.0
func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator
NewListApplicationsPaginator returns a new ListApplicationsPaginator
func (*ListApplicationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListApplicationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApplicationsPaginator) NextPage ¶ added in v0.30.0
func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)
NextPage retrieves the next ListApplications page.
type ListApplicationsPaginatorOptions ¶ added in v0.30.0
type ListApplicationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListApplicationsPaginatorOptions is the paginator options for ListApplications
type ListConfigurationProfilesAPIClient ¶ added in v0.30.0
type ListConfigurationProfilesAPIClient interface {
ListConfigurationProfiles(context.Context, *ListConfigurationProfilesInput, ...func(*Options)) (*ListConfigurationProfilesOutput, error)
}
ListConfigurationProfilesAPIClient is a client that implements the ListConfigurationProfiles operation.
type ListConfigurationProfilesInput ¶
type ListConfigurationProfilesInput 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 // A filter based on the type of configurations that the configuration profile // contains. A configuration can be a feature flag or a freeform configuration. Type *string // contains filtered or unexported fields }
type ListConfigurationProfilesOutput ¶
type ListConfigurationProfilesOutput struct { // The elements from this collection. Items []types.ConfigurationProfileSummary // 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 // contains filtered or unexported fields }
type ListConfigurationProfilesPaginator ¶ added in v0.30.0
type ListConfigurationProfilesPaginator struct {
// contains filtered or unexported fields
}
ListConfigurationProfilesPaginator is a paginator for ListConfigurationProfiles
func NewListConfigurationProfilesPaginator ¶ added in v0.30.0
func NewListConfigurationProfilesPaginator(client ListConfigurationProfilesAPIClient, params *ListConfigurationProfilesInput, optFns ...func(*ListConfigurationProfilesPaginatorOptions)) *ListConfigurationProfilesPaginator
NewListConfigurationProfilesPaginator returns a new ListConfigurationProfilesPaginator
func (*ListConfigurationProfilesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListConfigurationProfilesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListConfigurationProfilesPaginator) NextPage ¶ added in v0.30.0
func (p *ListConfigurationProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfigurationProfilesOutput, error)
NextPage retrieves the next ListConfigurationProfiles page.
type ListConfigurationProfilesPaginatorOptions ¶ added in v0.30.0
type ListConfigurationProfilesPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListConfigurationProfilesPaginatorOptions is the paginator options for ListConfigurationProfiles
type ListDeploymentStrategiesAPIClient ¶ added in v0.30.0
type ListDeploymentStrategiesAPIClient interface {
ListDeploymentStrategies(context.Context, *ListDeploymentStrategiesInput, ...func(*Options)) (*ListDeploymentStrategiesOutput, error)
}
ListDeploymentStrategiesAPIClient is a client that implements the ListDeploymentStrategies operation.
type ListDeploymentStrategiesInput ¶
type ListDeploymentStrategiesInput 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 // contains filtered or unexported fields }
type ListDeploymentStrategiesOutput ¶
type ListDeploymentStrategiesOutput struct { // The elements from this collection. Items []types.DeploymentStrategy // 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 // contains filtered or unexported fields }
type ListDeploymentStrategiesPaginator ¶ added in v0.30.0
type ListDeploymentStrategiesPaginator struct {
// contains filtered or unexported fields
}
ListDeploymentStrategiesPaginator is a paginator for ListDeploymentStrategies
func NewListDeploymentStrategiesPaginator ¶ added in v0.30.0
func NewListDeploymentStrategiesPaginator(client ListDeploymentStrategiesAPIClient, params *ListDeploymentStrategiesInput, optFns ...func(*ListDeploymentStrategiesPaginatorOptions)) *ListDeploymentStrategiesPaginator
NewListDeploymentStrategiesPaginator returns a new ListDeploymentStrategiesPaginator
func (*ListDeploymentStrategiesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDeploymentStrategiesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDeploymentStrategiesPaginator) NextPage ¶ added in v0.30.0
func (p *ListDeploymentStrategiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentStrategiesOutput, error)
NextPage retrieves the next ListDeploymentStrategies page.
type ListDeploymentStrategiesPaginatorOptions ¶ added in v0.30.0
type ListDeploymentStrategiesPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDeploymentStrategiesPaginatorOptions is the paginator options for ListDeploymentStrategies
type ListDeploymentsAPIClient ¶ added in v0.30.0
type ListDeploymentsAPIClient interface {
ListDeployments(context.Context, *ListDeploymentsInput, ...func(*Options)) (*ListDeploymentsOutput, error)
}
ListDeploymentsAPIClient is a client that implements the ListDeployments operation.
type ListDeploymentsInput ¶
type ListDeploymentsInput struct { // The application ID. // // This member is required. ApplicationId *string // The environment ID. // // This member is required. EnvironmentId *string // The maximum number of items that may be returned for this call. If there are // items that have not yet been returned, the response will include a non-null // NextToken that you can provide in a subsequent call to get the next set of // results. MaxResults int32 // The token returned by a prior call to this operation indicating the next set of // results to be returned. If not specified, the operation will return the first // set of results. NextToken *string // contains filtered or unexported fields }
type ListDeploymentsOutput ¶
type ListDeploymentsOutput struct { // The elements from this collection. Items []types.DeploymentSummary // 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 // contains filtered or unexported fields }
type ListDeploymentsPaginator ¶ added in v0.30.0
type ListDeploymentsPaginator struct {
// contains filtered or unexported fields
}
ListDeploymentsPaginator is a paginator for ListDeployments
func NewListDeploymentsPaginator ¶ added in v0.30.0
func NewListDeploymentsPaginator(client ListDeploymentsAPIClient, params *ListDeploymentsInput, optFns ...func(*ListDeploymentsPaginatorOptions)) *ListDeploymentsPaginator
NewListDeploymentsPaginator returns a new ListDeploymentsPaginator
func (*ListDeploymentsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDeploymentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDeploymentsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDeploymentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeploymentsOutput, error)
NextPage retrieves the next ListDeployments page.
type ListDeploymentsPaginatorOptions ¶ added in v0.30.0
type ListDeploymentsPaginatorOptions struct { // The maximum number of items that may be returned for this call. If there are // items that have not yet been returned, the response will include a non-null // NextToken that you can provide in a subsequent call to get the next set of // results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDeploymentsPaginatorOptions is the paginator options for ListDeployments
type ListEnvironmentsAPIClient ¶ added in v0.30.0
type ListEnvironmentsAPIClient interface {
ListEnvironments(context.Context, *ListEnvironmentsInput, ...func(*Options)) (*ListEnvironmentsOutput, error)
}
ListEnvironmentsAPIClient is a client that implements the ListEnvironments operation.
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListEnvironmentsPaginator ¶ added in v0.30.0
type ListEnvironmentsPaginator struct {
// contains filtered or unexported fields
}
ListEnvironmentsPaginator is a paginator for ListEnvironments
func NewListEnvironmentsPaginator ¶ added in v0.30.0
func NewListEnvironmentsPaginator(client ListEnvironmentsAPIClient, params *ListEnvironmentsInput, optFns ...func(*ListEnvironmentsPaginatorOptions)) *ListEnvironmentsPaginator
NewListEnvironmentsPaginator returns a new ListEnvironmentsPaginator
func (*ListEnvironmentsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListEnvironmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnvironmentsPaginator) NextPage ¶ added in v0.30.0
func (p *ListEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
NextPage retrieves the next ListEnvironments page.
type ListEnvironmentsPaginatorOptions ¶ added in v0.30.0
type ListEnvironmentsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListEnvironmentsPaginatorOptions is the paginator options for ListEnvironments
type ListHostedConfigurationVersionsAPIClient ¶ added in v0.30.0
type ListHostedConfigurationVersionsAPIClient interface {
ListHostedConfigurationVersions(context.Context, *ListHostedConfigurationVersionsInput, ...func(*Options)) (*ListHostedConfigurationVersionsOutput, error)
}
ListHostedConfigurationVersionsAPIClient is a client that implements the ListHostedConfigurationVersions operation.
type ListHostedConfigurationVersionsInput ¶
type ListHostedConfigurationVersionsInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *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 // contains filtered or unexported fields }
type ListHostedConfigurationVersionsOutput ¶
type ListHostedConfigurationVersionsOutput struct { // The elements from this collection. Items []types.HostedConfigurationVersionSummary // 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 // contains filtered or unexported fields }
type ListHostedConfigurationVersionsPaginator ¶ added in v0.30.0
type ListHostedConfigurationVersionsPaginator struct {
// contains filtered or unexported fields
}
ListHostedConfigurationVersionsPaginator is a paginator for ListHostedConfigurationVersions
func NewListHostedConfigurationVersionsPaginator ¶ added in v0.30.0
func NewListHostedConfigurationVersionsPaginator(client ListHostedConfigurationVersionsAPIClient, params *ListHostedConfigurationVersionsInput, optFns ...func(*ListHostedConfigurationVersionsPaginatorOptions)) *ListHostedConfigurationVersionsPaginator
NewListHostedConfigurationVersionsPaginator returns a new ListHostedConfigurationVersionsPaginator
func (*ListHostedConfigurationVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListHostedConfigurationVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListHostedConfigurationVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListHostedConfigurationVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHostedConfigurationVersionsOutput, error)
NextPage retrieves the next ListHostedConfigurationVersions page.
type ListHostedConfigurationVersionsPaginatorOptions ¶ added in v0.30.0
type ListHostedConfigurationVersionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListHostedConfigurationVersionsPaginatorOptions is the paginator options for ListHostedConfigurationVersions
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The resource ARN. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
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 StartDeploymentInput ¶
type StartDeploymentInput struct { // The application ID. // // This member is required. ApplicationId *string // The configuration profile ID. // // This member is required. ConfigurationProfileId *string // The configuration version to deploy. // // This member is required. ConfigurationVersion *string // The deployment strategy ID. // // This member is required. DeploymentStrategyId *string // The environment ID. // // This member is required. EnvironmentId *string // A description of the deployment. Description *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 // contains filtered or unexported fields }
type StartDeploymentOutput ¶
type StartDeploymentOutput struct { // The ID of the application that was deployed. ApplicationId *string // The time the deployment completed. CompletedAt *time.Time // Information about the source location of the configuration. ConfigurationLocationUri *string // The name of the configuration. ConfigurationName *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes int32 // The sequence number of the deployment. DeploymentNumber int32 // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The description of the deployment. Description *string // The ID of the environment that was deployed. EnvironmentId *string // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []types.DeploymentEvent // 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 to receive a deployed configuration during each // interval. GrowthFactor float32 // 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 time the deployment started. StartedAt *time.Time // The state of the deployment. State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopDeploymentInput ¶
type StopDeploymentInput struct { // The application ID. // // This member is required. ApplicationId *string // The sequence number of the deployment. // // This member is required. DeploymentNumber int32 // The environment ID. // // This member is required. EnvironmentId *string // contains filtered or unexported fields }
type StopDeploymentOutput ¶
type StopDeploymentOutput struct { // The ID of the application that was deployed. ApplicationId *string // The time the deployment completed. CompletedAt *time.Time // Information about the source location of the configuration. ConfigurationLocationUri *string // The name of the configuration. ConfigurationName *string // The ID of the configuration profile that was deployed. ConfigurationProfileId *string // The configuration version that was deployed. ConfigurationVersion *string // Total amount of time the deployment lasted. DeploymentDurationInMinutes int32 // The sequence number of the deployment. DeploymentNumber int32 // The ID of the deployment strategy that was deployed. DeploymentStrategyId *string // The description of the deployment. Description *string // The ID of the environment that was deployed. EnvironmentId *string // A list containing all events related to a deployment. The most recent events are // displayed first. EventLog []types.DeploymentEvent // 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 to receive a deployed configuration during each // interval. GrowthFactor float32 // 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 time the deployment started. StartedAt *time.Time // The state of the deployment. State types.DeploymentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateApplicationInput ¶
type UpdateApplicationOutput ¶
type UpdateApplicationOutput struct { // The description of the application. Description *string // The application ID. Id *string // The application name. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateConfigurationProfileInput ¶
type UpdateConfigurationProfileInput struct { // 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 // 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 // A list of methods for validating the configuration. Validators []types.Validator // contains filtered or unexported fields }
type UpdateConfigurationProfileOutput ¶
type UpdateConfigurationProfileOutput struct { // The application ID. ApplicationId *string // The configuration profile description. Description *string // The configuration profile ID. Id *string // The URI location of the configuration. LocationUri *string // 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 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 // A list of methods for validating the configuration. Validators []types.Validator // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDeploymentStrategyInput ¶
type UpdateDeploymentStrategyInput struct { // The deployment strategy ID. // // This member is required. DeploymentStrategyId *string // Total amount of time for a deployment to last. DeploymentDurationInMinutes int32 // A description of the deployment strategy. Description *string // 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. 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. Exponential: For this type, AppConfig processes the // deployment exponentially using the following formula: G*(2^N). In this formula, // G is the growth factor specified by the user and N 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: // 2*(2^0) // 2*(2^1) // // 2*(2^2) 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. GrowthType types.GrowthType // contains filtered or unexported fields }
type UpdateDeploymentStrategyOutput ¶
type UpdateDeploymentStrategyOutput 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 types.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 types.ReplicateTo // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateEnvironmentInput ¶
type UpdateEnvironmentInput struct { // The application ID. // // This member is required. ApplicationId *string // The environment ID. // // This member is required. EnvironmentId *string // A description of the environment. Description *string // Amazon CloudWatch alarms to monitor during the deployment process. Monitors []types.Monitor // The name of the environment. Name *string // contains filtered or unexported fields }
type UpdateEnvironmentOutput ¶
type UpdateEnvironmentOutput 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 []types.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 types.EnvironmentState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ValidateConfigurationOutput ¶
type ValidateConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go