Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkakar
jkakar committed Jan 26, 2016
1 parent bfb1ead commit a29139e
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 88 deletions.
80 changes: 40 additions & 40 deletions src/aws_code_pipeline.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,28 @@
%% <i>Pipelines</i> are models of automated release processes. Each pipeline
%% is uniquely named, and consists of actions, gates, and stages.
%%
%% You can work with pipelines by calling: <ul> <li> <a>CreatePipeline</a>,
%% which creates a uniquely-named pipeline.</li> <li> <a>DeletePipeline</a>,
%% which deletes the specified pipeline.</li> <li> <a>GetPipeline</a>, which
%% returns information about a pipeline structure.</li> <li>
%% <a>GetPipelineState</a>, which returns information about the current state
%% of the stages and actions of a pipeline.</li> <li> <a>ListPipelines</a>,
%% which gets a summary of all of the pipelines associated with your
%% account.</li> <li> <a>StartPipelineExecution</a>, which runs the the most
%% recent revision of an artifact through the pipeline.</li> <li>
%% <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to
%% the structure of the pipeline.</li> </ul> Pipelines include <i>stages</i>,
%% which are which are logical groupings of gates and actions. Each stage
%% contains one or more actions that must complete before the next stage
%% begins. A stage will result in success or failure. If a stage fails, then
%% the pipeline stops at that stage and will remain stopped until either a
%% new version of an artifact appears in the source location, or a user takes
%% action to re-run the most recent artifact through the pipeline. You can
%% call <a>GetPipelineState</a>, which displays the status of a pipeline,
%% including the status of stages in the pipeline, or <a>GetPipeline</a>,
%% which returns the entire structure of the pipeline, including the stages
%% of that pipeline. For more information about the structure of stages and
%% actions, also refer to the <ulink
%% You can work with pipelines by calling: <ul><li><a>CreatePipeline</a>,
%% which creates a uniquely-named pipeline.</li> <li><a>DeletePipeline</a>,
%% which deletes the specified pipeline.</li> <li><a>GetPipeline</a>, which
%% returns information about a pipeline structure.</li>
%% <li><a>GetPipelineState</a>, which returns information about the current
%% state of the stages and actions of a pipeline.</li> <li>
%% <a>ListPipelines</a>, which gets a summary of all of the pipelines
%% associated with your account.</li> <li><a>StartPipelineExecution</a>,
%% which runs the the most recent revision of an artifact through the
%% pipeline.</li> <li><a>UpdatePipeline</a>, which updates a pipeline with
%% edits or changes to the structure of the pipeline.</li> </ul> Pipelines
%% include <i>stages</i>, which are which are logical groupings of gates and
%% actions. Each stage contains one or more actions that must complete before
%% the next stage begins. A stage will result in success or failure. If a
%% stage fails, then the pipeline stops at that stage and will remain stopped
%% until either a new version of an artifact appears in the source location,
%% or a user takes action to re-run the most recent artifact through the
%% pipeline. You can call <a>GetPipelineState</a>, which displays the status
%% of a pipeline, including the status of stages in the pipeline, or
%% <a>GetPipeline</a>, which returns the entire structure of the pipeline,
%% including the stages of that pipeline. For more information about the
%% structure of stages and actions, also refer to the <ulink
%% url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html">AWS
%% CodePipeline Pipeline Structure Reference</ulink>.
%%
Expand All @@ -55,9 +55,9 @@
%%
%% You can work with transitions by calling:
%%
%% <ul> <li> <a>DisableStageTransition</a>, which prevents artifacts from
%% transitioning to the next stage in a pipeline.</li> <li>
%% <a>EnableStageTransition</a>, which enables transition of artifacts
%% <ul> <li><a>DisableStageTransition</a>, which prevents artifacts from
%% transitioning to the next stage in a pipeline.</li>
%% <li><a>EnableStageTransition</a>, which enables transition of artifacts
%% between stages in a pipeline. </li> </ul> <b>Using the API to integrate
%% with AWS CodePipeline</b>
%%
Expand All @@ -70,25 +70,25 @@
%% source action might import a revision of an artifact from a source. You
%% can work with jobs by calling:
%%
%% <ul> <li> <a>AcknowledgeJob</a>, which confirms whether a job worker has
%% received the specified job,</li> <li> <a>GetJobDetails</a>, which returns
%% the details of a job,</li> <li> <a>PollForJobs</a>, which determines
%% whether there are any jobs to act upon, </li> <li>
%% <a>PutJobFailureResult</a>, which provides details of a job failure,
%% and</li> <li> <a>PutJobSuccessResult</a>, which provides details of a job
%% success.</li> </ul> </li> <li>Third party jobs, which are instances of an
%% <ul> <li><a>AcknowledgeJob</a>, which confirms whether a job worker has
%% received the specified job,</li> <li><a>GetJobDetails</a>, which returns
%% the details of a job,</li> <li><a>PollForJobs</a>, which determines
%% whether there are any jobs to act upon, </li>
%% <li><a>PutJobFailureResult</a>, which provides details of a job failure,
%% and</li> <li><a>PutJobSuccessResult</a>, which provides details of a job
%% success.</li> </ul></li> <li>Third party jobs, which are instances of an
%% action created by a partner action and integrated into AWS CodePipeline.
%% Partner actions are created by members of the AWS Partner Network. You can
%% work with third party jobs by calling:
%%
%% <ul> <li> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job
%% worker has received the specified job,</li> <li>
%% <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a
%% partner action,</li> <li> <a>PollForThirdPartyJobs</a>, which determines
%% whether there are any jobs to act upon, </li> <li>
%% <a>PutThirdPartyJobFailureResult</a>, which provides details of a job
%% failure, and</li> <li> <a>PutThirdPartyJobSuccessResult</a>, which
%% provides details of a job success.</li> </ul> </li> </ul>
%% <ul><li><a>AcknowledgeThirdPartyJob</a>, which confirms whether a job
%% worker has received the specified job,</li>
%% <li><a>GetThirdPartyJobDetails</a>, which requests the details of a job
%% for a partner action,</li> <li><a>PollForThirdPartyJobs</a>, which
%% determines whether there are any jobs to act upon, </li>
%% <li><a>PutThirdPartyJobFailureResult</a>, which provides details of a job
%% failure, and</li> <li><a>PutThirdPartyJobSuccessResult</a>, which provides
%% details of a job success.</li> </ul></li> </ul>
-module(aws_code_pipeline).

-export([acknowledge_job/2,
Expand Down
15 changes: 7 additions & 8 deletions src/aws_ops_works.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,15 @@
%%
%% When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a>
%% we recommend you use the <code>ConfigurationManager</code> parameter to
%% specify the Chef version. The recommended value for Linux stacks, which is
%% also the default value, is currently 11.10. Windows stacks use Chef 12.2.
%% For more information, see <a
%% specify the Chef version. The recommended value for Linux stacks is
%% currently 12 (the default is 11.4). Windows stacks use Chef 12.2. For more
%% information, see <a
%% href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef
%% Versions</a>.
%%
%% <note>You can also specify Chef 11.4 or Chef 0.9 for your Linux stack.
%% However, Chef 0.9 has been deprecated. We do not recommend using Chef 0.9
%% for new stacks, and we recommend migrating your existing Chef 0.9 stacks
%% to Chef 11.10 as soon as possible.</note>
%% <note>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We
%% recommend migrating your existing Linux stacks to Chef 12 as soon as
%% possible.</note>
-module(aws_ops_works).

-export([assign_instance/2,
Expand Down Expand Up @@ -505,7 +504,7 @@ delete_user_profile(Client, Input, Options)
%% Manage permissions level for the stack or an attached policy that
%% explicitly grants permissions. For more information on user permissions,
%% see <a
%% href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"></a>.
%% href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"/>.
deregister_ecs_cluster(Client, Input)
when is_map(Client), is_map(Input) ->
deregister_ecs_cluster(Client, Input, []).
Expand Down
114 changes: 74 additions & 40 deletions src/aws_ssm.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,47 +47,81 @@
%% href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-configuration-manage.html">Managing
%% Windows Instance Configuration</a>.
%%
%% <para>SSM Config and Run Command include the following pre-defined
%% documents.</para> <table> <title>Amazon Pre-defined SSM Documents</title>
%% <tgroup cols="3"> <colspec colname="col1" colnum="1" colwidth="1*"/>
%% <colspec colname="col2" colnum="2" colwidth="1*"/> <colspec colname="col3"
%% colnum="3" colwidth="1*"/> <thead> <row> <entry>Name</entry>
%% SSM Config and Run Command include the following pre-defined documents.
%%
%% <table> <title>Amazon Pre-defined SSM Documents</title> <tgroup cols="3">
%% <colspec colname="col1" colnum="1" colwidth="1*"/> <colspec colname="col2"
%% colnum="2" colwidth="1*"/> <colspec colname="col3" colnum="3"
%% colwidth="1*"/> <thead> <row> <entry>Name</entry>
%% <entry>Description</entry> <entry>Platform</entry> </row> </thead> <tbody>
%% <row> <entry> <para>AWS-RunShellScript</para> </entry> <entry> <para>Run
%% shell scripts</para> </entry> <entry> <para>Linux</para> </entry> </row>
%% <row> <entry> <para>AWS-UpdateSSMAgent</para> </entry> <entry>
%% <para>Update the Amazon SSM agent</para> </entry> <entry>
%% <para>Linux</para> </entry> </row> <row> <entry>
%% <para>AWS-JoinDirectoryServiceDomain </para> </entry> <entry> <para>Join
%% an AWS Directory </para> </entry> <entry> <para>Windows</para> </entry>
%% </row> <row> <entry> <para>AWS-RunPowerShellScript</para> </entry> <entry>
%% <para>Run PowerShell commands or scripts</para> </entry> <entry>
%% <para>Windows</para> </entry> </row> <row> <entry>
%% <para>AWS-UpdateEC2Config</para> </entry> <entry> <para>Update the
%% EC2Config service </para> </entry> <entry> <para>Windows</para> </entry>
%% </row> <row> <entry> <para>AWS-ConfigureWindowsUpdate</para> </entry>
%% <entry> <para>Configure Windows Update settings</para> </entry> <entry>
%% <para>Windows</para> </entry> </row> <row> <entry>
%% <para>AWS-InstallApplication</para> </entry> <entry> <para>Install,
%% repair, or uninstall software using an MSI package</para> </entry> <entry>
%% <para>Windows</para> </entry> </row> <row> <entry>
%% <para>AWS-InstallPowerShellModule</para> </entry> <entry> <para>Install
%% PowerShell modules </para> </entry> <entry> <para>Windows</para> </entry>
%% </row> <row> <entry> <para>AWS-ConfigureCloudWatch</para> </entry> <entry>
%% <para>Configure Amazon CloudWatch Logs to monitor applications and
%% systems</para> </entry> <entry> <para>Windows</para> </entry> </row>
%% </tbody> </tgroup> </table> <important> <simpara>The commands or scripts
%% specified in SSM documents run with administrative privilege on your
%% instances because the Amazon SSM agent runs as root on Linux and the
%% EC2Config service runs in the Local System account on Windows. If a user
%% has permission to execute any of the pre-defined SSM documents (any
%% document that begins with AWS-*) then that user also has administrator
%% access to the instance. Delegate access to SSM and Run Command
%% judiciously. This becomes extremely important if you create your own SSM
%% documents. Amazon Web Services does not provide guidance about how to
%% create secure SSM documents. You create SSM documents and delegate access
%% to Run Command at your own risk. As a security best practice, we recommend
%% that you assign access to "AWS-*" documents, especially the
%% <row> <entry> AWS-RunShellScript
%%
%% </entry> <entry> Run shell scripts
%%
%% </entry> <entry> Linux
%%
%% </entry> </row> <row> <entry> AWS-UpdateSSMAgent
%%
%% </entry> <entry> Update the Amazon SSM agent
%%
%% </entry> <entry> Linux
%%
%% </entry> </row> <row> <entry> AWS-JoinDirectoryServiceDomain
%%
%% </entry> <entry> Join an AWS Directory
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-RunPowerShellScript
%%
%% </entry> <entry> Run PowerShell commands or scripts
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-UpdateEC2Config
%%
%% </entry> <entry> Update the EC2Config service
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-ConfigureWindowsUpdate
%%
%% </entry> <entry> Configure Windows Update settings
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-InstallApplication
%%
%% </entry> <entry> Install, repair, or uninstall software using an MSI
%% package
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-InstallPowerShellModule
%%
%% </entry> <entry> Install PowerShell modules
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> <row> <entry> AWS-ConfigureCloudWatch
%%
%% </entry> <entry> Configure Amazon CloudWatch Logs to monitor applications
%% and systems
%%
%% </entry> <entry> Windows
%%
%% </entry> </row> </tbody> </tgroup> </table> <important> <simpara>The
%% commands or scripts specified in SSM documents run with administrative
%% privilege on your instances because the Amazon SSM agent runs as root on
%% Linux and the EC2Config service runs in the Local System account on
%% Windows. If a user has permission to execute any of the pre-defined SSM
%% documents (any document that begins with AWS-*) then that user also has
%% administrator access to the instance. Delegate access to SSM and Run
%% Command judiciously. This becomes extremely important if you create your
%% own SSM documents. Amazon Web Services does not provide guidance about how
%% to create secure SSM documents. You create SSM documents and delegate
%% access to Run Command at your own risk. As a security best practice, we
%% recommend that you assign access to "AWS-*" documents, especially the
%% AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript
%% document on Windows, to trusted administrators only. You can create SSM
%% documents for specific tasks and delegate access to
Expand Down

0 comments on commit a29139e

Please sign in to comment.