Definição YAML da ação “Amazon S3 publish”

A seguir está a definição YAML da ação de publicação do Amazon S3. Para saber como usar essa ação, consultePublicaçã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 de fluxo de trabalho YAML.

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 do usuário, use Ctrl+F. O elemento será listado com sua 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: s3-bucket-name
      TargetPath: my/target

S3Publish

(Obrigatório)

Especifique o nome da ação. Todos os nomes das ações devem ser exclusivos no fluxo de trabalho. Os nomes das ações são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hífens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para ativar caracteres especiais e espaços nos nomes das ações.

Padrão: S3Publish_nn.

UI correspondente: guia de 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 Especificar a versão principal, secundária ou de patch de uma ação.

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

UI correspondente: diagrama de fluxo de trabalho/ S3Publish _nn/ aws/s3-publish @v1 label

DependsOn

(S3Publish/DependsOn)

(Optional)

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

Para obter mais informações sobre a funcionalidade “depende de”, consulte. Configurando ações para depender de outras ações

UI correspondente: guia Entradas/Depende de - opcional

Compute

(S3Publish/Compute)

(Optional)

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

UI correspondente: nenhuma

Type

(S3Publish/Compute/Type)

(Obrigatório se Compute estiver incluído)

O tipo de mecanismo de computação. Você pode usar um dos seguintes valores:

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

  Otimizado para flexibilidade durante as corridas 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.

UI correspondente: guia de configuração/tipo de computação

Fleet

(S3Publish/Compute/Fleet)

(Optional)

Especifique a máquina ou frota que executará seu fluxo de trabalho ou 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 é concluída. Exemplos de frotas sob demanda:Linux.x86-64.Large,. Linux.x86-64.XLarge Para obter mais informações sobre frotas sob demanda, consulte. Propriedades de frota sob demanda

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

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

UI correspondente: guia de 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 executada antes de CodeCatalyst finalizar a ação. O mínimo é de 5 minutos e o máximo está descrito emCotas para fluxos de trabalho. O tempo limite padrão é o mesmo que o tempo limite máximo.

UI correspondente: guia de configuração/tempo limite - opcional

Inputs

(S3Publish/Inputs)

(Optional)

A Inputs seção define os dados S3Publish necessários durante a execução de um fluxo de trabalho.

nota

São permitidas no máximo quatro entradas (uma fonte e três artefatos) para cada ação de AWS CDK implantação. As variáveis não contam para esse total.

Se você precisar se referir a arquivos que residem em entradas diferentes (digamos, uma fonte e um artefato), a entrada de origem é a entrada primária e o artefato é a entrada secundária. As referências a arquivos em entradas secundárias usam um prefixo especial para diferenciá-las das primárias. Para obter detalhes, consulte Exemplo: referenciando arquivos em vários artefatos.

UI 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 Conectando um fluxo de trabalho a um repositório de origem.

UI correspondente: guia Entradas/Fontes - 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 contidos em um artefato gerado por uma ação anterior, especifique esse artefato aqui. Se seus arquivos não estiverem contidos em um artefato, eles deverão residir no seu repositório de origem.

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de dados entre ações em um fluxo de trabalho usando artefatos.

UI correspondente: guia de configuração/artefatos - opcional

Variables - input

(S3Publish/Inputs/Variables)

(Optional)

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 das variáveis são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hífens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para habilitar caracteres especiais e espaços em nomes de variáveis.

Para obter mais informações sobre variáveis, incluindo exemplos, consulteConfigurando e usando variáveis em um fluxo de trabalho.

UI correspondente: guia de entradas/variáveis - opcional

Environment

(S3Publish/Environment)

(Obrigatório)

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

nota

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

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

UI correspondente: guia de configuração/ambiente

Name

(S3Publish/Environment/Name)

(Obrigatório se Environment estiver incluído)

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

UI correspondente: guia de 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. Você pode especificar no máximo uma conexão de conta emEnvironment.

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

• A ação usa a Conta da AWS conexão e a função padrão do IAM especificadas no ambiente no CodeCatalyst console. Para obter informações sobre como adicionar uma conexão de conta e uma função padrão do IAM ao ambiente, consulteCriar um ambiente.

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

Para obter mais informações sobre conexões de conta, consultePermitindo acesso a AWS recursos com conexão Contas da AWS. Para obter informações sobre como adicionar uma conexão de conta a um ambiente, consulteCriar um ambiente.

UI correspondente: uma das seguintes, dependendo da versão da ação:

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

• (Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ conexão AWS de conta

Name

(S3Publish/Environment/Connections/Name)

(Obrigatório se Connections estiver incluído)

Especifique o nome da conexão da conta.

UI correspondente: uma das seguintes, dependendo da versão da ação:

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

• (Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ conexão AWS de conta

Role

(S3Publish/Environment/Connections/Role)

(Obrigatório se Connections estiver incluído)

Especifique o nome da função do IAM que a ação de publicação do Amazon S3 usa para acessar AWS e copiar arquivos para o Amazon S3. Certifique-se de ter adicionado a função ao seu CodeCatalyst espaço e de que a função inclua as seguintes políticas.

Se você não especificar uma função do IAM, a ação usará a função padrão do IAM listada no ambiente no CodeCatalyst console. Se você usar a função padrão no ambiente, verifique se ela tem as seguintes políticas.

• A seguinte política de permissões:

  Atenção

  Limite as permissões às mostradas na política a seguir. Usar uma função 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 seguinte política de confiança personalizada:

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

nota

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

UI correspondente: uma das seguintes, dependendo da versão da ação:

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

• (Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ Função

Configuration

(S3Publish/Configuration)

(Obrigatório)

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

UI 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 do /myFolder para o Amazon S3 e preserva a estrutura de diretórios subjacente.

Especificando ./myFolder/myfile.txt cópias somente myfile.txt para o Amazon S3. (A estrutura de diretórios foi removida.)

Você não pode usar curingas.

nota

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

UI correspondente: guia de 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.

UI correspondente: guia de configuração/bucket de destino - opcional

TargetPath

(S3Publish/Configuration/TargetPath)

(Optional)

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

Exemplos:

myS3Folder

./myS3Folder/myS3Subfolder

UI correspondente: guia de configuração/diretório de destino - opcional