Working with the Atlassian Jira extension for Amazon AppConfig - Amazon AppConfig
Configuring permissionsConfiguring integrationDeleting integration
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Working with the Atlassian Jira extension for Amazon AppConfig

By integrating with Atlassian Jira, Amazon AppConfig can create and update issues in the Atlassian console whenever you make changes to a feature flag in your Amazon Web Services account for the specified Amazon Web Services Region. Each Jira issue includes the flag name, application ID, configuration profile ID, and flag values. After you update, save, and deploy your flag changes, Jira updates the existing issues with the details of the change.

Note

Jira updates issues whenever you create or update a feature flag. Jira also updates issues when you delete a child-level flag attribute from a parent-level flag. Jira does not record information when you delete a parent-level flag.

To configure integration, you must do the following:

Configuring permissions for Amazon AppConfig Jira integration

When you configure Amazon AppConfig integration with Jira, you specify credentials for a user. Specifically, you enter the user's access key ID and secret key in the Amazon AppConfig for Jira application. This user gives Jira permission to communicate with Amazon AppConfig. Amazon AppConfig uses these credentials one time to establish an association between Amazon AppConfig and Jira. The credentials are not stored. You can remove the association by uninstalling the Amazon AppConfig for Jira application.

The user account requires a permission policy that includes the following actions:

  • appconfig:CreateExtensionAssociation

  • appconfig:GetConfigurationProfile

  • appconfig:ListApplications

  • appconfig:ListConfigurationProfiles

  • appconfig:ListExtensionAssociations

  • sts:GetCallerIdentity

Complete the following tasks to create an IAM permission policy and a user for Amazon AppConfig and Jira integration:

Tasks

Task 1: Create an IAM permission policy for Amazon AppConfig and Jira integration

Use the following procedure to create an IAM permission policy that allows Atlassian Jira to communicate with Amazon AppConfig. We recommend that you create a new policy and attach this policy to a new IAM role. Adding the required permission to an existing IAM policy and role goes against the principle of least privilege and is not recommended.

To create an IAM policy for Amazon AppConfig and Jira integration

  1. Open the IAM console at https://console.amazonaws.cn/iam/.

  2. In the navigation pane, choose Policies, and then choose Create policy.

  3. On the Create policy page, choose the JSON tab and replace the default content with the following policy. In the following policy, replace Region, account_ID, application_ID, and configuration_profile_ID with information from your Amazon AppConfig feature flag environment.

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                       "appconfig:CreateExtensionAssociation",
                       "appconfig:ListExtensionAssociations",
                       "appconfig:GetConfigurationProfile"                       
             ],
            "Resource": [
                       "arn:aws-cn:appconfig:Region:account_ID:application/application_ID",
                       "arn:aws-cn:appconfig:Region:account_ID:application/application_ID/configurationprofile/configuration_profile_ID"
             ]
        },
       {
            "Effect": "Allow",
            "Action": [
                       "appconfig:ListApplications"
                       
             ],
            "Resource": [
                       "arn:aws-cn:appconfig:Region:account_ID:*"
             ]
        },
         {
            "Effect": "Allow",
            "Action": [
                       "appconfig:ListConfigurationProfiles"
             ],
            "Resource": [
                       "arn:aws-cn:appconfig:Region:account_ID:application/application_ID"
             ]
        },
        {
            "Effect": "Allow",
            "Action": "sts:GetCallerIdentity",
            "Resource": "*"
        }
    ]
}

  4. Choose Next: Tags.

  5. (Optional) Add one or more tag-key value pairs to organize, track, or control access for this policy, and then choose Next: Review.

  6. On the Review policy page, enter a name in the Name box, such as AppConfigJiraPolicy, and then enter an optional description.

  7. Choose Create policy.

Task 2: Create a user for Amazon AppConfig and Jira integration

Use the following procedure to create a user for Amazon AppConfig and Atlassian Jira integration. After you create the user, you can copy the access key ID and secret key, which you will specify when you complete the integration.

To create a user for Amazon AppConfig and Jira integration

  1. Open the IAM console at https://console.amazonaws.cn/iam/.

  2. In the navigation pane, choose Users, and then choose Add users.

  3. In the User name field, enter a name, such as AppConfigJiraUser.

  4. For Select Amazon credential type, choose Access key - Programmatic access.

  5. Choose Next: Permissions.

  6. Under Set permissions page, choose Attach existing policies directly. Search for and select the check box for the policy that you created in Task 1: Create an IAM permission policy for Amazon AppConfig and Jira integration, and then choose Next: Tags.

  7. On the Add tags (optional) page, add one or more tag-key value pairs to organize, track, or control access for this user. Choose Next: Review.

  8. On the Review page, verify the user details.

  9. Choose Create user. The system displays the user's access key ID and secret key. Either download the .csv file or copy these credentials to a separate location. You will specify these credentials when you configure integration.

Configuring the Amazon AppConfig Jira integration application

Use the following procedure to configure required options in the Amazon AppConfig for Jira application. After you complete this procedure, Jira creates a new issue for each feature flag in your Amazon Web Services account for the specified Amazon Web Services Region. If you make changes to a feature flag in Amazon AppConfig, Jira records the details in the existing issues.

Note

An Amazon AppConfig feature flag can include multiple child-level flag attributes. Jira creates one issue for each parent-level feature flag. If you change a child-level flag attribute, you can view the details of that change in the Jira issue for the parent-level flag.

To configure integration

  1. Log in to the Atlassian Marketplace.

  2. Type Amazon AppConfig in the search field and press Enter.

  3. Install the application on your Jira instance.

  4. In the Atlassian console, choose Manage apps, and then choose Amazon AppConfig for Jira.

  5. Choose Configure.

  6. Under Configuration details, choose Jira project and then choose the project that you want to associate with your Amazon AppConfig feature flag.

  7. Choose Amazon Web Services Region, and then choose the Region where your Amazon AppConfig feature flag is located.

  8. In the Application ID field, enter the name of the Amazon AppConfig application that contains your feature flag.

  9. In the Configuration profile ID field, enter the name of the Amazon AppConfig configuration profile for your feature flag.

  10. In the Access key ID and Secret key fields, enter the credentials you copied in Task 2: Create a user for Amazon AppConfig and Jira integration. Optionally, you can also specify a session token.

  11. Choose Submit.

  12. In the Atlassian console, choose Projects, and then choose the project you selected for Amazon AppConfig integration. The Issues page displays an issue for each feature flag in the specified Amazon Web Services account and Amazon Web Services Region.

Deleting the Amazon AppConfig for Jira application and data

If you no longer want to use Jira integration with Amazon AppConfig feature flags, you can delete the Amazon AppConfig for Jira application in the Atlassian console. Deleting the integration application does the following:

  • Deletes the association between your Jira instance and Amazon AppConfig

  • Deletes your Jira instance details from Amazon AppConfig

To delete the Amazon AppConfig for Jira application

  1. In the Atlassian console, choose Manage apps.

  2. Choose Amazon AppConfig for Jira.

  3. Choose Uninstall.