Ação YAML de “Publicação no Amazon S3” - Amazon CodeCatalyst

Ação YAML de “Publicação no Amazon S3”

Confira a seguir a definição de YAML da ação Publicação no Amazon S3. Para saber como usar essa ação, consulte Publicação de arquivos no Amazon S3 com um fluxo de trabalho.

Essa definição de ação existe como uma seção dentro de um arquivo de definição de fluxo de trabalho mais amplo. Para obter mais informações sobre esse arquivo, consulte Definição do YAML do fluxo de trabalho.

nota

A maioria das propriedades YAML a seguir tem elementos de interface de usuário correspondentes no editor visual. Para pesquisar um elemento de interface, use Ctrl+F. O elemento será listado com a propriedade YAML associada.

# The workflow definition starts here. # See Propriedades de nível superior for details. Name: MyWorkflow SchemaVersion: 1.0 Actions: # The action definition starts here. S3Publish_nn: Identifier: aws/s3-publish@v1 DependsOn: - build-action Compute: Type: EC2 | Lambda Fleet: fleet-name Timeout: timeout-minutes Inputs: Sources: - source-name-1 Artifacts: - artifact-name Variables: - Name: variable-name-1 Value: variable-value-1 - Name: variable-name-2 Value: variable-value-2 Environment: Name: environment-name Connections: - Name: account-connection-name Role: iam-role-name Configuration: SourcePath: my/source DestinationBucketName: amzn-s3-demo-bucket TargetPath: my/target

S3Publish

(Obrigatório)

Especifique o nome da ação. Todos os nomes de ação devem ser exclusivos no fluxo de trabalho. Os nomes de ação são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (_). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de ação.

Padrão: S3Publish_nn.

Interface de usuário correspondente: guia Configuração/Nome da ação

Identifier

(S3Publish/Identifier)

(Obrigatório)

Identifica a ação. Não altere essa propriedade, a menos que você queira alterar a versão. Para ter mais informações, consulte Especificação da versão da ação a ser usada.

Padrão: aws/s3-publish@v1.

Interface de usuário correspondente: Diagrama de fluxo de trabalho/S3Publish_nn/rótulo aws/s3-publish@v1

DependsOn

(S3Publish/DependsOn)

(Opcional)

Especifique uma ação, um grupo de ação ou um portão que deve ser executado com êxito para que essa ação seja executada.

Para ter mais informações sobre a funcionalidade “Depende de”, consulte Sequenciar ações.

Interface de usuário correspondente: guia Entradas/Depende de - opcional

Compute

(S3Publish/Compute)

(Opcional)

O mecanismo de computação usado para executar as ações de fluxo de trabalho. É possível especificar a computação em nível de fluxo de trabalho ou em nível de ação, mas não em ambos. Quando especificada em nível de fluxo de trabalho, a configuração de computação se aplica a todas as ações definidas no fluxo de trabalho. Em nível de fluxo de trabalho, também é possível realizar várias ações na mesma instância. Para ter mais informações, consulte Compartilhamento de computação entre ações.

Interface de usuário correspondente: nenhuma

Type

(S3Publish/Compute/Type)

(Obrigatório se Compute for incluído)

O tipo do mecanismo de computação. É possível usar um dos seguintes valores:

  • EC2 (editor visual) ou EC2 (editor YAML)

    Otimizado para flexibilidade durante as execuções de ação.

  • Lambda (editor visual) ou Lambda (editor YAML)

    Velocidades otimizadas de inicialização da ação.

Para obter informações sobre tipos de dados, consulte Tipos de computação.

Interface de usuário correspondente: guia Configuração/Tipo de computação

Fleet

(S3Publish/Compute/Fleet)

(Opcional)

Especifique a máquina ou a frota que executará o fluxo de trabalho ou as ações de fluxo de trabalho. Com frotas sob demanda, quando uma ação é iniciada, o fluxo de trabalho provisiona os recursos necessários e as máquinas são destruídas quando a ação termina. Exemplos de frota sob demanda: Linux.x86-64.Large, Linux.x86-64.XLarge. Para ter mais informações sobre frotas sob demanda, consulte Propriedades da frota sob demanda.

Com frotas provisionadas, você configura um conjunto de máquinas dedicadas para realizar as ações do fluxo de trabalho. Essas máquinas permanecem ociosas, prontas para processar ações imediatamente. Para ter mais informações sobre frotas provisionadas, consulte Propriedades da frota provisionada.

Se Fleet for omitido, o padrão será Linux.x86-64.Large.

Interface de usuário correspondente: guia Configuração/Frota de computação

Timeout

(S3Publish/Timeout)

(Obrigatório)

Especifique a quantidade de tempo em minutos (editor YAML) ou horas e minutos (editor visual) que a ação pode ser realizada antes que o CodeCatalyst termine a ação. O mínimo é de cinco minutos e o máximo está descrito em Cotas para fluxos de trabalho no CodeCatalyst. O tempo limite padrão é igual ao tempo limite máximo.

Interface de usuário correspondente: guia Configuração/Tempo limite - opcional

Inputs

(S3Publish/Inputs)

(Opcional)

A seção Inputs define os dados que S3Publish precisa durante a execução de um fluxo de trabalho.

nota

São permitidas no máximo quatro entradas (uma origem e três artefatos) para cada ação Implantação do AWS CDK. As variáveis não são contadas nesse total.

Se você precisar consultar arquivos que residem em entradas diferentes (digamos, uma origem e um artefato), a entrada de origem será a entrada primária e o artefato será a entrada secundária. As referências a arquivos em entradas secundárias usam um prefixo especial para diferirem das primárias. Para obter detalhes, consulte Exemplo: referência de arquivos em vários artefatos.

Interface de usuário correspondente: guia Entradas

Sources

(S3Publish/Inputs/Sources)

(Obrigatório se os arquivos que você deseja publicar no Amazon S3 estiverem armazenados em um repositório de origem)

Se os arquivos que você deseja publicar no Amazon S3 estiverem armazenados em um repositório de origem, especifique o rótulo desse repositório de origem. Atualmente, o único rótulo compatível é WorkflowSource.

Se os arquivos que você deseja publicar no Amazon S3 não estiverem contidos em um repositório de origem, eles devem residir em um artefato gerado por outra ação.

Para obter mais informações sobre fontes, consulte Conectar repositórios de origem aos fluxos de trabalho.

Interface de usuário correspondente: guia Entradas/Origens - opcional

Artifacts - input

(S3Publish/Inputs/Artifacts)

(Obrigatório se os arquivos que você deseja publicar no Amazon S3 estiverem armazenados em um artefato de saída de uma ação anterior)

Se os arquivos que você deseja publicar no Amazon S3 estiverem em um artefato gerado por uma ação anterior, especifique esse artefato aqui. Se as aplicações não estiverem em um artefato, elas deverão residir no repositório de origem.

Para ter mais informações sobre artefatos, inclusive exemplos, consulte Compartilhar artefatos e arquivos entre ações.

Interface de usuário correspondente: guia Configuração/Artefatos - opcional

Variables - input

(S3Publish/Inputs/Variables)

(Opcional)

Especifique uma sequência de pares de nome/valor que definam as variáveis de entrada que você deseja disponibilizar para a ação. Os nomes de variável são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (_). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de variável.

Para ter mais informações sobre variáveis, inclusive exemplos, consulte Uso de variáveis em fluxos de trabalho.

Interface de usuário correspondente: guia Entradas/Variáveis - opcional

Environment

(S3Publish/Environment)

(Obrigatório)

Especifique o ambiente do CodeCatalyst a ser usado com a ação. A ação se conecta à Conta da AWS e à Amazon VPC opcional especificada no ambiente escolhido. A ação usa o perfil do IAM padrão especificado no ambiente para se conectar à Conta da AWS e usa o perfil do IAM especificado na conexão da Amazon VPC para se conectar à Amazon VPC.

nota

Se o perfil do IAM padrão não tiver as permissões exigidas pela ação, você poderá configurar a ação para usar um perfil diferente. Para ter mais informações, consulte Alteração do perfil do IAM de uma ação.

Para ter mais informações sobre ambientes, consulte Implantação em Contas da AWS e VPCs e Criar um ambiente.

Interface de usuário correspondente: guia Configuração/Ambiente

Name

(S3Publish/Environment/Name)

(Obrigatório se Environment for incluído)

Especifique o nome de um ambiente existente que deseja associar à ação.

Interface de usuário correspondente: guia Configuração/Ambiente

Connections

(S3Publish/Environment/Connections)

(Opcional nas versões mais recentes da ação; obrigatório nas versões mais antigas)

Especifique a conexão da conta a ser associada à ação. É possível especificar no máximo uma conexão de conta em Environment.

Se você não especificar uma conexão de conta:

  • A ação usa a conexão da Conta da AWS e o perfil do IAM padrão especificados no ambiente no console do CodeCatalyst. Para ter informações sobre como adicionar uma conexão de conta e um perfil do IAM padrão ao ambiente, consulte Criar um ambiente.

  • O perfil do IAM padrão deve incluir as políticas e as permissões exigidas pela ação. Para determinar quais são essas políticas e permissões, consulte a descrição da propriedade Perfil na documentação de definição de YAML da ação.

Para ter mais informações sobre conexões de conta, consulte Permissão do acesso a recursos da AWS com Contas da AWS conectadas. Para ter informações sobre como adicionar uma conexão de conta a um ambiente, consulte Criar um ambiente.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/”Ambiente/conta/perfil”/conexão de conta da AWS

Name

(S3Publish/Environment/Connections/Name)

(Obrigatório se Connections for incluído)

Especifique o nome da conexão da conta.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/”Ambiente/conta/perfil”/conexão de conta da AWS

Role

(S3Publish/Environment/Connections/Role)

(Obrigatório se Connections for incluído)

Especifique o nome do perfil do IAM que a ação Publicação no Amazon S3 usa para acessar AWS e copiar arquivos para o Amazon S3. Adicione o perfil ao seu espaço do CodeCatalyst e verifique se o perfil inclui as políticas a seguir.

Se você não especificar um perfil do IAM, a ação usará o perfil padrão listado no ambiente no console do CodeCatalyst. Se você usar o perfil padrão no ambiente, verifique se ele tem as políticas a seguir.

  • A política de permissões a seguir:

    Atenção

    Limite as permissões às exibidas na política a seguir. Usar um perfil com permissões mais amplas pode representar um risco de segurança.

    { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "s3:PutObject", "s3:ListBucket", "s3:DeleteObject" ], "Resource": [ "arn:aws:s3:::bucket-name", "arn:aws:s3:::bucket-name/*" ] } ] }
  • A política de confiança personalizada a seguir:

    { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codecatalyst-runner.amazonaws.com", "codecatalyst.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }
nota

Você pode usar o perfil CodeCatalystWorkflowDevelopmentRole-spaceName com essa ação, se desejar. Para obter mais informações sobre essa função, consulte Criar o perfil CodeCatalystWorkflowDevelopmentRole-spaceName para a conta e o espaço. Entenda que o perfil CodeCatalystWorkflowDevelopmentRole-spaceName tem permissões de acesso completas, o que pode representar um risco de segurança. Recomendamos que você use esse perfil apenas em tutoriais e em cenários em que a segurança seja menos preocupante.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

  • (Versões mais recentes) Guia Configuração/Ambiente/O que há no meu ambiente?/menu de três pontos/Mudar de perfil

  • (Versões mais antigas) Guia Configuração/“Ambiente/conta/perfil”/Perfil

Configuration

(S3Publish/Configuration)

(Obrigatório)

Uma seção na qual você pode definir as propriedades de configuração da ação.

Interface de usuário correspondente: guia Configuração

SourcePath

(S3Publish/Configuration/SourcePath)

(Obrigatório)

Especifique o nome e o caminho de um diretório ou arquivo que você deseja publicar no Amazon S3. O diretório ou arquivo pode residir em um repositório de origem ou em um artefato de uma ação anterior e é relativo ao repositório de origem ou à raiz do artefato.

Exemplos:

A especificação ./myFolder/ copia o conteúdo de /myFolder para o Amazon S3 e preserva a estrutura de diretórios subjacente.

A especificação ./myFolder/myfile.txt copia somente myfile.txt para o Amazon S3. (A estrutura de diretórios foi removida.)

Não é possível usar curingas.

nota

Talvez seja necessário adicionar um prefixo ao diretório ou caminho do arquivo para indicar em qual artefato ou origem encontrá-lo. Para ter mais informações, consulte Fazer referência a arquivos do repositório de origem e Referência de arquivos em um artefato.

Interface de usuário correspondente: guia Configuração/Caminho de origem

DestinationBucketName

(S3Publish/Configuration/DestinationBucketName)

(Obrigatório)

Especifique o nome do bucket do Amazon S3 em que você deseja publicar os arquivos.

Interface de usuário correspondente: guia Configuração/Bucket de destino - opcional

TargetPath

(S3Publish/Configuration/TargetPath)

(Opcional)

Especifique o nome e o caminho do diretório no Amazon S3 em que você deseja publicar seus arquivos. Se o diretório não existir, ele será criada. O caminho do diretório não deve incluir o nome do bucket.

Exemplos:

myS3Folder

./myS3Folder/myS3Subfolder

Interface de usuário correspondente: guia Configuração/Diretório de destino - opcional