Method format_examples

samcli/commands/deploy/core/command.py:23–72

(ctx: Context, formatter: CommandHelpTextFormatter)

    @staticmethod
    def format_examples(ctx: Context, formatter: CommandHelpTextFormatter):
        with formatter.indented_section(name="Examples", extra_indents=1):
            with formatter.indented_section(name="Deploy with guided prompts", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(f"$ {ctx.command_path} --guided"),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(name="Deploy with specified parameters", extra_indents=1):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --template-file packaged.yaml --stack-name "
                                f"sam-app --capabilities CAPABILITY_IAM"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(
                name="Deploy with parameter overrides using CloudFormation syntax", extra_indents=1
            ):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --parameter-overrides "
                                f"'ParameterKey=InstanceType,ParameterValue=t1.micro'"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )
            with formatter.indented_section(
                name="Deploy with parameter overrides using shorthand syntax", extra_indents=1
            ):
                formatter.write_text_rows(
                    [
                        RowDefinition(
                            name=style(
                                f"$ {ctx.command_path} --parameter-overrides KeyPairName=MyKey InstanceType=t1.micro"
                            ),
                            extra_row_modifiers=[ShowcaseRowModifier()],
                        ),
                    ]
                )

    @staticmethod
    def format_acronyms(formatter: CommandHelpTextFormatter):