From 58a763b209886863366b32b645bad46a54987cb6 Mon Sep 17 00:00:00 2001 From: splunk-soar-connectors-admin Date: Tue, 1 Aug 2023 11:47:47 -0700 Subject: [PATCH] 'convert readme.html to manual_readme_content.md' --- manual_readme_content.md | 35 +++++++++++++++++++++++++++++++++++ readme.html | 18 ------------------ 2 files changed, 35 insertions(+), 18 deletions(-) create mode 100644 manual_readme_content.md delete mode 100644 readme.html diff --git a/manual_readme_content.md b/manual_readme_content.md new file mode 100644 index 0000000..64ce1ce --- /dev/null +++ b/manual_readme_content.md @@ -0,0 +1,35 @@ +[comment]: # " File: README.md" +[comment]: # " Copyright (c) 2018-2021 Splunk Inc." +[comment]: # "" +[comment]: # " SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part" +[comment]: # " without a valid written license from Splunk Inc. is PROHIBITED." +[comment]: # "" +## Asset Configuration + +There are two ways to configure an AWS WAF asset. The first is to configure the **access_key** , +**secret_key** and **region** variables. If it is preferred to use a role and Phantom is running as +an EC2 instance, the **use_role** checkbox can be checked instead. This will allow the role that is +attached to the instance to be used. Please see the [AWS EC2 and IAM +documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) +for more information. + +Region parameter provided in the asset configuration parameter and region of the bucket which is +created in AWS console must match, otherwise the user will get an InvalidLocationConstraint error. + +For the **Update bucket** action, the +API is unable to validate the KMS key. Hence, it is recommended to provide a +valid KMS key in this action parameter, otherwise it will affect the S3 bucket. For example, +if we update the S3 bucket with an invalid KMS key and run the +'create object' action on the bucket then the action will not work for encryption = NONE. + +## Assumed Role Credentials + +The optional **credentials** action parameter consists of temporary **assumed role** credentials +that will be used to perform the action instead of those that are configured in the **asset** . The +parameter is not designed to be configured manually, but should instead be used in conjunction with +the Phantom AWS Security Token Service app. The output of the **assume_role** action of the STS app +with data path **assume_role\_\:action_result.data.\*.Credentials** consists of a dictionary +containing the **AccessKeyId** , **SecretAccessKey** , **SessionToken** and **Expiration** key/value +pairs. This dictionary can be passed directly into the credentials parameter in any of the following +actions within a playbook. For more information, please see the [AWS Identity and Access Management +documentation](https://docs.aws.amazon.com/iam/index.html) . diff --git a/readme.html b/readme.html deleted file mode 100644 index df34af5..0000000 --- a/readme.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -

Asset Configuration

-There are two ways to configure an AWS WAF asset. The first is to configure the access_key, secret_key and region variables. If it is preferred to use a role and Phantom is running as an EC2 instance, the use_role checkbox can be checked instead. This will allow the role that is attached to the instance to be used. Please see the AWS EC2 and IAM documentation for more information. - -

Region parameter provided in the asset configuration parameter and region of the bucket which is created in AWS console must match, otherwise the user will get an InvalidLocationConstraint error.

-

For the Update bucket action, the API is unable to validate the KMS key. Hence, it is recommended to provide a valid KMS key in this action parameter, otherwise it will affect the S3 bucket. For example, if we update the S3 bucket with an invalid KMS key and run the 'create object' action on the bucket then the action will not work for encryption = NONE.

- -

Assumed Role Credentials

-The optional credentials action parameter consists of temporary assumed role credentials that will be used to perform the action instead of those that are configured in the asset. The parameter is not designed to be configured manually, but should instead be used in conjunction with the Phantom AWS Security Token Service app. The output of the assume_role action of the STS app with data path assume_role_<number>:action_result.data.*.Credentials consists of a dictionary containing the AccessKeyId, SecretAccessKey, SessionToken and Expiration key/value pairs. This dictionary can be passed directly into the credentials parameter in any of the following actions within a playbook. For more information, please see the AWS Identity and Access Management documentation. - -